diff --git a/README.md b/README.md index e69de29..1b6e03f 100644 --- a/README.md +++ b/README.md @@ -0,0 +1,19 @@ +# space - A simple shell written in C++ + +## What is space? + +Space is a shell. Not much else. + +## How to use? + +1. Compile (`g++ src/main.cpp -o space`). + +2. Run the outputted binary (`space`). + +3. Run your commands inside the shell. + +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 38 to add directories to your path. + +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)