Major restructuring

[gen-shell.git] / README.md

diff --git a/README.md b/README.md
index d6f057c76aadac38d401ea9f983b73bc7a4f9780..5b0e8356c34e5000384987693a1cd20d433bc4f2 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,4 +1,20 @@
 # gen-shell
-![Jenkins](https://img.shields.io/jenkins/build?jobUrl=https%3A%2F%2Fbuild.bhojwani.org%2Fjob%2Fgen-shell%2F)
+A simple way to turn any command into a REPL with arrow key/history support.
 
-A work in progress generic shell forked form [taskshell](https://github.com/GothenburgBitFactory/taskshell)
+## Usage
+See `gen-shell --help`
+
+## Installation
+Dependencies:  
+  - POSIX make
+  - a c++ compiler and standard library
+  - libreadline development files (7 or 8 is fine, 5 is untested)
+
+```bash
+make
+make install
+```
+## 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.