Major restructuring

[gen-shell.git] / README.md

diff --git a/README.md b/README.md
index 516bbcb600ef1ca1249a61ba2ffc52f33b505ac7..5b0e8356c34e5000384987693a1cd20d433bc4f2 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,27 +1,18 @@
 # gen-shell
-[![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 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).
+A simple way to turn any command into a REPL with arrow key/history support.
 
 ## 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). 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)
+  - POSIX make
+  - a c++ compiler and standard library
+  - libreadline development files (7 or 8 is fine, 5 is untested)
 
 ```bash
-git clone https://git.sr.ht/~armaan/gen-shell
-cd gen-shell
-cmake .
-sudo make install
+make
+make install
 ```
 ## License
 Following suit from taskshell, gen-shell is MIT licensed by Armaan Bhojwani, 2021. Gen-shell is forked from taskshell, which was developed by [these people](https://github.com/GothenburgBitFactory/taskshell/blob/master/AUTHORS).