commit 6cd390a6498b029b302b46d043df0d3aa1c66e30
parent 15d5cf0bddfddf56db658be8ba2d78a0059a391c
Author: night0721 <[email protected]>
Date: Wed, 22 May 2024 10:58:27 +0100
update readme to remove gcc as dependencies
Diffstat:
1 file changed, 13 insertions(+), 12 deletions(-)
diff --git a/README.md b/README.md
@@ -4,20 +4,21 @@ rush is a minimalistic shell for Unix systems written in C.
* Disclaimer: This project is for me to learn to write Unix syscalls, code might be inefficient, feel free to point out the mistakes and open a issue for that!
-## Preview
+# Preview
[]()
[]()
-## Dependencies
-- gcc
+# Dependencies
-## Building
-```sh
+None
+
+# Building
+```
$ make
-$ sudo make install
+# make install
```
-## Usage
+# Usage
```sh
$ ./rush
@@ -31,7 +32,7 @@ $ ./rush
# >& to redirect both stdout and stderr
```
-## Features
+# Features
- No dependencies except a compiler
- Showing current time and directory with custom color
- Syntax highlighting on valid commands using ANSI colors
@@ -44,7 +45,7 @@ $ ./rush
- stdin, stdout, stderr redirect
- Background jobs
-## Built in commands
+# Built in commands
- cd
- help
- exit
@@ -54,10 +55,10 @@ $ ./rush
- j
- bg
-## Notes
+# Notes
- History is either saved in HOME or XDG_CONFIG_HOME if it is defined
-## Todo Features
+# Todo Features
- Tab completion
- Git integration
- Allow arguments with space in double quotes
@@ -70,7 +71,7 @@ Contributions are welcomed, feel free to open a pull request.
# License
This project is licensed under the GNU Public License v3.0. See [LICENSE](https://github.com/night0721/rush/blob/master/LICENSE) for more information.
-## Credits
+# Credits
- [Tutorial - Write a shell in C](https://brennan.io/2015/01/16/write-a-shell-in-c/)
- [dash](https://github.com/danishprakash/dash)
- [Shell assignment](https://www.cs.cornell.edu/courses/cs414/2004su/homework/shell/shell.html)
