]> git.armaanb.net Git - gen-shell.git/blob - README.md
Major restructuring
[gen-shell.git] / README.md
1 # gen-shell
2 A simple way to turn any command into a REPL with arrow key/history support.
3
4 ## Usage
5 See `gen-shell --help`
6
7 ## Installation
8 Dependencies:  
9   - POSIX make
10   - a c++ compiler and standard library
11   - libreadline development files (7 or 8 is fine, 5 is untested)
12
13 ```bash
14 make
15 make install
16 ```
17 ## License
18 Following suit from taskshell, gen-shell is MIT licensed by Armaan Bhojwani, 2021. Gen-shell is forked from taskshell, which was developed by [these people](https://github.com/GothenburgBitFactory/taskshell/blob/master/AUTHORS).
19
20 Gen-shell uses the [Sarge library](https://github.com/MayaPosch/Sarge) for parsing command-line arguments. Sarge was written by Maya Posch and is BSD 3-Clause licensed.