commit 779a7847e2db806fcd71d1abff2f426d643833c9
parent 120fe74984f0806889310c9867aa19f44d8ce84a
Author: night0721 <[email protected]>
Date: Wed, 22 May 2024 11:25:02 +0100
update readme
Diffstat:
M | README.md | | | 58 | ++++++++++++++++++++++++++++------------------------------ |
1 file changed, 28 insertions(+), 30 deletions(-)
diff --git a/README.md b/README.md
@@ -7,6 +7,34 @@ rush is a minimalistic shell for Unix systems written in C.
[![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
@@ -31,39 +59,9 @@ $ make
# make install
```
-# 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
-
# Notes
- History is either saved in HOME or XDG_CONFIG_HOME if it is defined
-# 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
-
# Contributions
Contributions are welcomed, feel free to open a pull request.