made usable!

[gen-shell.git] / README.md

diff --git a/README.md b/README.md
index 953d7c7b0dc3cb6797720c0ae11cd4464580ce7c..d48c1564e07e2b190b12cafda40ace1795c060df 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,2 +1,25 @@
 # gen-shell
-A work in progress generic shell forked form [taskshell](https://github.com/GothenburgBitFactory/taskshell)
+![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.
+
+## Usage
+Just put the command that you want to repeat as the argument
+
+## 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
+
+```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`