90s/README.md

# rush
Minimalist, customizable shell with syntax highlighting.

* 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
[![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)]()

# Features
- No dependencies except a compiler
- Showing current time and directory with custom color
- Syntax highlighting on valid commands using ANSI colors
- History navigation using up and down keys with history command
- Support for environment variables
- Editing using left and right arrow keys
- !! to repeat last command
- Pipes
- autojump to directorys
- stdin, stdout, stderr redirect
- Background jobs
## Built in commands
- cd
- help
- exit
- history
- export
- source
- j
- bg
## Todo Features
- Tab completion
- Git integration
- Allow arguments with space in double quotes
- Underline file path if it exists `echo -e "\033[4mabc\033[0m"`
- Aliases

# Usage
```sh
$ ./rush

# > to redirect stdout
# < to redirect stdin
# 2> to redirect stderr
# >> to append to file
# & to run command in background
# | to pipe
# !! to repeat last command
# >& to redirect both stdout and stderr
```

# Dependencies
None

# Building
You will need to run these with elevated privilages.
```
$ make
# make install
```

# Notes
- History is either saved in HOME or XDG_CONFIG_HOME if it is defined

# Contributions
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
- [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)
- [khol](https://github.com/SanketDG/khol/)
Initial commit 2024-01-31 02:02:32 +01:00			`# rush`
update description 2024-05-22 17:04:17 +02:00			`Minimalist, customizable shell with syntax highlighting.`
Initial commit 2024-01-31 02:02:32 +01:00
disclaimer in readme 2024-02-08 20:47:44 +01:00			`* 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!`

update readme to remove gcc as dependencies 2024-05-22 11:58:27 +02:00			`# Preview`
fix preview 2024-02-04 21:30:03 +01:00			`[![Valid command](https://r2.e-z.host/3c62bb3a-a8a9-43f6-afd6-553646f51dc4/aqnpvvud.png)]()`
fix preview 2024-02-04 21:31:44 +01:00			`[![Invalid command](https://r2.e-z.host/3c62bb3a-a8a9-43f6-afd6-553646f51dc4/xf80dq0b.png)]()`
add preview 2024-02-04 21:27:24 +01:00
update readme 2024-05-22 12:25:02 +02:00			`# Features`
			`- No dependencies except a compiler`
			`- Showing current time and directory with custom color`
			`- Syntax highlighting on valid commands using ANSI colors`
			`- History navigation using up and down keys with history command`
			`- Support for environment variables`
			`- Editing using left and right arrow keys`
			`- !! to repeat last command`
			`- Pipes`
			`- autojump to directorys`
			`- stdin, stdout, stderr redirect`
			`- Background jobs`
			`## Built in commands`
			`- cd`
			`- help`
			`- exit`
			`- history`
			`- export`
			`- source`
			`- j`
			`- bg`
			`## Todo Features`
			`- Tab completion`
			`- Git integration`
			`- Allow arguments with space in double quotes`
			- Underline file path if it exists `echo -e "\033[4mabc\033[0m"`
			`- Aliases`

update readme to remove gcc as dependencies 2024-05-22 11:58:27 +02:00			`# Usage`
Initial commit 2024-01-31 02:02:32 +01:00			```sh
			`$ ./rush`
delete comments and add usage in readme 2024-02-16 14:45:35 +01:00
			`# > to redirect stdout`
			`# < to redirect stdin`
			`# 2> to redirect stderr`
			`# >> to append to file`
			`# & to run command in background`
			`# \| to pipe`
			`# !! to repeat last command`
			`# >& to redirect both stdout and stderr`
Initial commit 2024-01-31 02:02:32 +01:00			```

update readme 2024-05-22 12:11:40 +02:00			`# Dependencies`
			`None`

			`# Building`
			`You will need to run these with elevated privilages.`
			```
			`$ make`
			`# make install`
			```

update readme to remove gcc as dependencies 2024-05-22 11:58:27 +02:00			`# Notes`
notes 2024-02-16 23:32:14 +01:00			`- History is either saved in HOME or XDG_CONFIG_HOME if it is defined`

fix make and add license contributions 2024-02-18 22:46:10 +01:00			`# Contributions`
			`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.`

update readme to remove gcc as dependencies 2024-05-22 11:58:27 +02:00			`# Credits`
Initial commit 2024-01-31 02:02:32 +01:00			`- [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)`
			`- [khol](https://github.com/SanketDG/khol/)`