nice multi-stage dockerfile

[gen-shell.git] / README.md

diff --git a/README.md b/README.md
index d48c1564e07e2b190b12cafda40ace1795c060df..db4eee26722cc1743a1c1f2eaa7429b39740ddc8 100644 (file)
--- a/README.md
+++ b/README.md
@@ -7,8 +7,11 @@ A simple way to turn any command into a shell with arrow key/history suppoert. T
 Just put the command that you want to repeat as the argument
 
 ## Installation
+### Binaries
 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.
 
+
+### From source
 If you would like to avoid this, you can build from source. Doing so requires:
   - CMake
   - g++
@@ -23,3 +26,9 @@ 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
+```