From f01ea8af6d58881edcd087d79797611bbc4d54f8 Mon Sep 17 00:00:00 2001 From: Maxwell Jeffress Date: Mon, 24 Mar 2025 15:46:46 +1100 Subject: [PATCH] Update README --- README.md | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 7b44efc..3b81f28 100644 --- a/README.md +++ b/README.md @@ -2,11 +2,11 @@ ## What is space? -Space is a shell. Not much else. +Space is a shell. There is a simple substitutions feature, which can substitute something for something else. ## How to use? -1. Compile (`g++ src/main.cpp -o space`). +1. Compile (`g++ src/main.cpp -o space`). (may differ by OS or personal preference, this works for Linux) 2. Run the outputted binary (`space`). @@ -14,6 +14,10 @@ Space is a shell. Not much else. If you need to change your directory, run `cd (directory)`. If you need to exit the shell, type `exit`. -The path is hard-coded into the source code, change the vector on line 40 to add directories to your path. +If you would like to create a substitution, type `sub (string) (anotherstring)`. List all your substitutions with `listsubs`. By default, `ls` is substituted with `ls -l`. If you'd like to make your substitutions include extra command line arguments, write your arguments inside quotation marks. + +The path is hard-coded into the source code, change the vector on line 59 to add directories to your path. + +The prompt is not able to be changed. Yes, I'm forcing my opinion on you. If you want to run an executable in your current directory, there's no need for the ./ (keep in mind Space will prioritise local executables over ones in the path)