README.md

   1 # gen-shell
   2 [![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?)
   3
   4 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).
   5
   6 ## Usage
   7 See `gen-shell --help`
   8
   9 ## Installation
  10 ### From a binary
  11 Binaries can be downloaded from [here](https://builds.sr.ht/~armaan/gen-shell/commits/.build.yml) tab above. NB: these binaries are compiled against libreadline version 8
  12
  13 ### From source
  14 Dependencies:
  15   - cmake (2.8 or higher)
  16   - make
  17   - g++ (sometimes packaged as gcc-c++ or gcc-g++)
  18   - libreadline development files (7 or 8 is fine, 5 is untested) (optional, but highly recommended)
  19
  20 ```bash
  21 git clone https://git.sr.ht/~armaan/gen-shell
  22 cd gen-shell
  23 cmake .
  24 sudo make install
  25 ```
  26 ## License
  27 Following suit from taskshell, gen-shell is MIT licensed by Armaan Bhojwani, 2020. Gen-shell is forked from taskshell, which was developed by [these people](https://github.com/GothenburgBitFactory/taskshell/blob/master/AUTHORS).
  28
  29 Gen-shell uses the [Sarge library](https://github.com/MayaPosch/Sarge) for parsing command-line arguments. Sarge was written by Maya Posch and is BSD 3-Clause licensed.