update README

[gen-shell.git] / README.md

diff --git a/README.md b/README.md
index d6f057c76aadac38d401ea9f983b73bc7a4f9780..31fa5be6c35e293295af7b87bad00b0183705dd6 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,4 +1,29 @@
 # gen-shell
-![Jenkins](https://img.shields.io/jenkins/build?jobUrl=https%3A%2F%2Fbuild.bhojwani.org%2Fjob%2Fgen-shell%2F)
+[![builds.sr.ht status](https://builds.sr.ht/~armaan/gen-shell/commits/.build.yml.svg)](https://builds.sr.ht/~armaan/gen-shell/commits/.build.yml?)
 
-A work in progress generic shell forked form [taskshell](https://github.com/GothenburgBitFactory/taskshell)
+A simple way to turn any command into a shell with arrow key/history support (if compiled with libreadline). Forked from [taskshell](https://github.com/GothenburgBitFactory/taskshell).
+
+## Usage
+See `gen-shell --help`
+
+## Installation
+### From a binary
+Binaries can be downloaded from [here](https://builds.sr.ht/~armaan/gen-shell/commits/.build.yml) tab above. NB: these binaries are compiled against libreadline version 8
+
+### From source
+Dependencies:  
+  - cmake (2.8 or higher)
+  - make
+  - g++ (sometimes packaged as gcc-c++ or gcc-g++)
+  - libreadline development files (7 or 8 is fine, 5 is untested) (optional, but highly recommended)
+
+```bash
+git clone https://git.sr.ht/~armaan/gen-shell
+cd gen-shell
+cmake .
+sudo make install
+```
+## License
+Following suit from taskshell, gen-shell is MIT licensed by Armaan Bhojwani, 2020. 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.