X-Git-Url: https://git.armaanb.net/?a=blobdiff_plain;f=README.md;h=a7d8e301c5152da1e988e80c36ed00c6a21d2281;hb=d8afd601de1f0d8afe6eff61d40ff52d21d90fd8;hp=d6f057c76aadac38d401ea9f983b73bc7a4f9780;hpb=28d8445c8c2c2e1b1a30ddef30fc9c5555645aeb;p=gen-shell.git

diff --git a/README.md b/README.md
index d6f057c..a7d8e30 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,45 @@
 # gen-shell
-![Jenkins](https://img.shields.io/jenkins/build?jobUrl=https%3A%2F%2Fbuild.bhojwani.org%2Fjob%2Fgen-shell%2F)
+![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 shell with arrow key/history support. This is a fork of [taskshell](https://github.com/GothenburgBitFactory/taskshell) with a highly reduce codebase.
 
-A work in progress generic shell forked form [taskshell](https://github.com/GothenburgBitFactory/taskshell)
+## Usage
+Just put the command that you want to repeat after `gen-shell`, eg; `gen-shell ls`, or even something much more complex like `gen-shell "cd /home/armaa/Clone/words && /home/armaa/Clone/words/bin/words` This command was actually the inspiration for gen-shell.
+
+## Installation
+### Binaries
+Binaries can be downloaded [from here](https://build.bhojwani.org/job/gen-shell/lastSuccessfulBuild/artifact/build/src/gen-shell). NB: these binaries are compiled against libreadline7, so if your system only has libreadline8, you can 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.
+
+### From source
+If you would like to avoid this, you can build from source. Doing so requires:
+  - cmake (2.8 or higher)
+  - make
+  - gcc
+  - g++ (sometimes packaged as gcc-c++ or gcc-g++)
+  - cpp (11 or higher)
+  - 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/
+```
+Or if you don't have root access, you can subsitute the last line with
+`cp src/gen-shell ~/.local/bin`
+
+### Docker
+You can also run gen-shell in docker. Simply use
+```bash
+docker run -it -e CMD=<command-to-run> armaanb/gen-shell:latest
+```
+Or to build the docker container locally
+```bash
+git clone https://codeberg.org/armaan/gen-shell
+cd gen-shell
+docker build -t armaanb/gen-shell:latest .
+docker run -it -e CMD=<command-to-run> armaanb/gen-shell
+```
+## License
+Following suit from tasksh, gen-shell is MIT licensed by Armaan Bhojwani, 2020. Gen-shell is forked from tasksh, from which its codebase has been greatly reduced, although the majority of code remaining was written by the tasksh developers [(listed here)](https://github.com/GothenburgBitFactory/taskshell/blob/master/AUTHORS).
+
+Gen-shell uses [Sarge](https://github.com/MayaPosch/Sarge) for parsing command-line arguments. Sarge was written by Maya Posch and is BSD 3-Clause licensed