Skip to content

Commit

Permalink
README update
Browse files Browse the repository at this point in the history
  • Loading branch information
bexxmodd committed Jul 27, 2021
1 parent 2415737 commit e2249f8
Showing 1 changed file with 24 additions and 8 deletions.
32 changes: 24 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@
Currently, `cr4sh_` provides the following functionality:

- Multiprocessing
- SIGINT and SIGKILL signall handling
- SIGINT and SIGKILL signal handling
- Execution of OS executables
- Redirection of standard input output
- Redirection of standard input & output
- Appending stdout to the file
- Piping commands and combining with redirection
- `cd` command to change directories
Expand All @@ -22,23 +22,38 @@ Currently, `cr4sh_` provides the following functionality:

<br>

To run the shell do the following steps:
## Installation

1. copy current repo with `git clone
2. `cd` into `cr4sh_` directory
3. start the shell by running `cargo run`
To run the `cr4sh_` shell copy following code in your terminal:

Currently looking to add other custom functions (which are listed in TODO list) and if you want to contribute looking into the `customs` folder inside the `src` folder is a great start. If you want just add any of the functionality and I'll take of gluing with the rest of the program.
```bash
git clone https://github.com/bexxmodd/cr4sh_.git && \
cd cr4sh_ && \
cargo run
```

<br>

## Plans

<br>
Currently I'm looking to add other custom shell functions (which are listed in the TODO list) and if you want to contribute looking into the `customs` directory inside the `src` directory is a great start. If you want just add any of the functionality and I'll take of gluing with the rest of the program. Also, if you have design skills some 80's style logo can be a great contribution!
<br>
<br>

Main priority right now is to add cursor and history function.
<br>

### TODO:

- [ ] Create a logo
- [x] Allow piping of the commands
- [x] Add personalized color printing of the terminal user
- [x] Allow execution of local executables properly
- [x] Allow chain of commands when `&&` is supplied
- [x] Handle append (`>>`) directive
- [ ] Handle `&` symbol to send command as a background process
- [ ] Expend singal handling capabilities
- [ ] Expend signal handling capabilities
- [ ] Implement cursor to handle arrow, home, end keyboard inputs and cursor movement
- [ ] Usage of Tab to autocomplete commands and file/directory names
- [x] Implement `touch` function:
Expand All @@ -47,3 +62,4 @@ Currently looking to add other custom functions (which are listed in TODO list)
- [ ] Implement redirection for custom functions:
- [ ] add additional argument to functions for stdout file
- [ ] Implement piping for custom functions
- [ ] Add customization of colors and style for a shell-name

0 comments on commit e2249f8

Please sign in to comment.