X-Git-Url: https://git.armaanb.net/?p=gen-shell.git;a=blobdiff_plain;f=README.md;h=c1f9fc8861fcfc53876e60f652d0f37b733b79c6;hp=11f0511d5116f94efe75cc693b2de2e335e1d6b2;hb=f5b6ded9977a1df7f102c65666c9b0a89d7a4a6c;hpb=1b1c96ff94fc455d9f658395b738c30eb7fc2e16 diff --git a/README.md b/README.md index 11f0511..c1f9fc8 100644 --- a/README.md +++ b/README.md @@ -12,13 +12,13 @@ Binaries can be downloaded [from here](https://build.bhojwani.org/job/gen-shell/ ### From source If you would like to avoid this, you can build from source. Doing so requires: - - cmake + - cmake (2.8 or higher) - make - gcc - g++ (sometimes packaged as gcc-c++ or gcc-g++) - - cpp 11 or higher - - libreadline development files (7 or 8 is fine) -``` + - cpp (11 or higher) + - libreadline development files (7 or 8 is fine, 5 is untested) +```bash git clone https://codeberg.org/armaan/gen-shell cd gen-shell cmake . @@ -30,6 +30,15 @@ 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= armaanb/gen-shell:latest ``` -docker run -it -e CMD= armaanb/gen-shell:latest +Or to build the docker container locally +```bash +git clone https://codeberg.org/armaan/gen-shell +cd gen-shell +docker build -t armaanb/gen-shell:latest . +docker run -it -e CMD= armaanb/gen-shell ``` +## License +Following suit from tasksh, gen-shell is MIT licensed by Armaan Bhojwani, 2020. Gen-shell is forked from tasksh, from which its codebase has been greatly reduced, although the majority of code remaining was written by the tasksh developers [(listed here)](https://github.com/GothenburgBitFactory/taskshell/blob/master/AUTHORS).