update readme to remove gcc as dependencies
This commit is contained in:
parent
15d5cf0bdd
commit
6cd390a649
1 changed files with 13 additions and 12 deletions
25
README.md
25
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!
|
* 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
|
||||||
[![Valid command](https://r2.e-z.host/3c62bb3a-a8a9-43f6-afd6-553646f51dc4/aqnpvvud.png)]()
|
[![Valid command](https://r2.e-z.host/3c62bb3a-a8a9-43f6-afd6-553646f51dc4/aqnpvvud.png)]()
|
||||||
[![Invalid command](https://r2.e-z.host/3c62bb3a-a8a9-43f6-afd6-553646f51dc4/xf80dq0b.png)]()
|
[![Invalid command](https://r2.e-z.host/3c62bb3a-a8a9-43f6-afd6-553646f51dc4/xf80dq0b.png)]()
|
||||||
|
|
||||||
## Dependencies
|
# Dependencies
|
||||||
- gcc
|
|
||||||
|
|
||||||
## Building
|
None
|
||||||
```sh
|
|
||||||
|
# Building
|
||||||
|
```
|
||||||
$ make
|
$ make
|
||||||
$ sudo make install
|
# make install
|
||||||
```
|
```
|
||||||
|
|
||||||
## Usage
|
# Usage
|
||||||
```sh
|
```sh
|
||||||
$ ./rush
|
$ ./rush
|
||||||
|
|
||||||
|
@ -31,7 +32,7 @@ $ ./rush
|
||||||
# >& to redirect both stdout and stderr
|
# >& to redirect both stdout and stderr
|
||||||
```
|
```
|
||||||
|
|
||||||
## Features
|
# Features
|
||||||
- No dependencies except a compiler
|
- No dependencies except a compiler
|
||||||
- Showing current time and directory with custom color
|
- Showing current time and directory with custom color
|
||||||
- Syntax highlighting on valid commands using ANSI colors
|
- Syntax highlighting on valid commands using ANSI colors
|
||||||
|
@ -44,7 +45,7 @@ $ ./rush
|
||||||
- stdin, stdout, stderr redirect
|
- stdin, stdout, stderr redirect
|
||||||
- Background jobs
|
- Background jobs
|
||||||
|
|
||||||
## Built in commands
|
# Built in commands
|
||||||
- cd
|
- cd
|
||||||
- help
|
- help
|
||||||
- exit
|
- exit
|
||||||
|
@ -54,10 +55,10 @@ $ ./rush
|
||||||
- j
|
- j
|
||||||
- bg
|
- bg
|
||||||
|
|
||||||
## Notes
|
# Notes
|
||||||
- History is either saved in HOME or XDG_CONFIG_HOME if it is defined
|
- History is either saved in HOME or XDG_CONFIG_HOME if it is defined
|
||||||
|
|
||||||
## Todo Features
|
# Todo Features
|
||||||
- Tab completion
|
- Tab completion
|
||||||
- Git integration
|
- Git integration
|
||||||
- Allow arguments with space in double quotes
|
- Allow arguments with space in double quotes
|
||||||
|
@ -70,7 +71,7 @@ Contributions are welcomed, feel free to open a pull request.
|
||||||
# License
|
# 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.
|
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/)
|
- [Tutorial - Write a shell in C](https://brennan.io/2015/01/16/write-a-shell-in-c/)
|
||||||
- [dash](https://github.com/danishprakash/dash)
|
- [dash](https://github.com/danishprakash/dash)
|
||||||
- [Shell assignment](https://www.cs.cornell.edu/courses/cs414/2004su/homework/shell/shell.html)
|
- [Shell assignment](https://www.cs.cornell.edu/courses/cs414/2004su/homework/shell/shell.html)
|
||||||
|
|
Loading…
Reference in a new issue