switched docker to debian-slim

[gen-shell.git] / README.md

diff --git a/README.md b/README.md
index db4eee26722cc1743a1c1f2eaa7429b39740ddc8..11f0511d5116f94efe75cc693b2de2e335e1d6b2 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,6 +1,6 @@
 # gen-shell
 ![Jenkins](https://img.shields.io/jenkins/build?jobUrl=https%3A%2F%2Fbuild.bhojwani.org%2Fjob%2Fgen-shell%2F)  
-=== WORK IN PROGRSS ===
+=== WORK IN PROGRESS ===  
 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
@@ -8,16 +8,17 @@ 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.
-
+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 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
-  - g++
-  - libreadline development files
-
-```bash
+  - cmake
+  - make
+  - gcc
+  - g++ (sometimes packaged as gcc-c++ or gcc-g++)
+  - cpp 11 or higher
+  - libreadline development files (7 or 8 is fine)
+```
 git clone https://codeberg.org/armaan/gen-shell
 cd gen-shell
 cmake .
@@ -29,6 +30,6 @@ Or if you don't have root access, you can subsitute the last line with
 
 ### Docker
 You can also run gen-shell in docker. Simply use
-```bash
+```
 docker run -it -e CMD=<command to run> armaanb/gen-shell:latest
 ```