# gen-shell
-![Jenkins](https://img.shields.io/jenkins/build?jobUrl=https%3A%2F%2Fbuild.bhojwani.org%2Fjob%2Fgen-shell%2F)
-=== WORK IN PROGRSS ===
-A simple way to turn any command into a shell with arrow key/history suppoert. This is a fork of [taskshell](https://github.com/GothenburgBitFactory/taskshell) with a highly reduce codebase.
+A simple way to turn any command into a REPL with arrow key/history support.
## Usage
-Just put the command that you want to repeat as the argument
+See `gen-shell --help`
## Installation
-Binaries can be downloaded [from here](https://build.bhojwani.org/job/gen-shell/lastSuccessfulBuild/artifact/build/src/gen-shell). Note that these binaries are compiled against libreadline7, so if your system only has libreadline8, you should symlink 8 to 7 with `sudo ln -s /usr/lib/x86_64-linux-gnu/libreadline.so.8.0 /usr/lib/x86_64-linux-gnu/libreadline.so.7`. This isn't a great solution, but it gets the job done.
-
-If you would like to avoid this, you can build from source. Doing so requires:
- - CMake
- - g++
- - libreadline development files
+Dependencies:
+ - POSIX make
+ - a c++ compiler and standard library
+ - libreadline development files (7 or 8 is fine, 5 is untested)
```bash
-git clone https://codeberg.org/armaan/gen-shell
-cd gen-shell
-cmake .
make
-sudo cp src/gen-shell /usr/bin/
+make install
```
-Or if you don't have root access, you can subsitute the last line with
-`cp src/gen-shell ~/.local/bin`
+## License
+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).
+
+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.