README.md

   1 # gen-shell
   2 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).
   3
   4 ## Usage
   5 See `gen-shell --help`
   6
   7 ## Installation
   8 ### From a binary
   9 Binaries can be downloaded from the refs tab above. NB: these binaries are compiled against libreadline version 8
  10
  11 ### From source
  12 Dependencies:
  13   - cmake (2.8 or higher)
  14   - make
  15   - g++ (sometimes packaged as gcc-c++ or gcc-g++)
  16   - libreadline development files (7 or 8 is fine, 5 is untested) (optional, but highly recommended)
  17
  18 ```bash
  19 git clone https://git.sr.ht/~armaan/gen-shell
  20 cd gen-shell
  21 cmake .
  22 sudo make install
  23 ```
  24 ## License
  25 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).
  26
  27 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.