X-Git-Url: https://git.armaanb.net/?a=blobdiff_plain;f=README.md;h=c22b212240fcead9a9aa764773521e46986169d2;hb=be112929a782f5f2cc6605a3f3a2b38db49c1d0d;hp=3a62a96872a5a452421c44649e8e99483345741f;hpb=ed587e970f8083d69f5e4d07aba04ee7435f2e4c;p=gen-shell.git diff --git a/README.md b/README.md index 3a62a96..c22b212 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,6 @@ # gen-shell -![Jenkins](https://img.shields.io/jenkins/build?jobUrl=https%3A%2F%2Fbuild.bhojwani.org%2Fjob%2Fgen-shell%2F) +[![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). ## Usage @@ -7,40 +8,22 @@ See `gen-shell --help` ## Installation ### From a binary -Binaries can be downloaded [from here](https://build.bhojwani.org/job/gen-shell/lastSuccessfulBuild/artifact/build/src/gen-shell). NB: 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. +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 -If you would like to avoid this, you can build from source. Doing so requires: +Dependencies: - cmake (2.8 or higher) - make - - gcc - g++ (sometimes packaged as gcc-c++ or gcc-g++) - - cpp (any somewhat recent version is fine) - - libreadline development files (7 or 8 is fine, 5 is untested) (optional, but highly reccomended) + - libreadline development files (7 or 8 is fine, 5 is untested) (optional, but highly recommended) -On a Debian or Ubuntu based distribution, you can install these dependencies with this command: -```bash -sudo apt update && sudo apt install cmake make gcc g++ cpp libreadline-dev -``` -Then download and build gen shell: ```bash -git clone --recursive https://codeberg.org/armaan/gen-shell +git clone https://git.sr.ht/~armaan/gen-shell cd gen-shell cmake . sudo make install ``` -### Docker -You can also run gen-shell in docker. Simply use -```bash -docker run -it -e command= -e before_command= -e after_command= -e custom_prompt= armaanb/gen-shell -``` -Or to build the docker container locally, run: -```bash -git clone --recursive https:/codeberg.org/armaan/gen-shell -cd gen-shell -docker build --no-cache -t gen-shell:latest . -``` ## License 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). -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. It is added as a submodule in the root folder of this repository. +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.