X-Git-Url: https://git.armaanb.net/?p=gen-shell.git;a=blobdiff_plain;f=README.md;h=b696a29937d2e06641d2af61f81d9a532419a5d6;hp=a7d8e301c5152da1e988e80c36ed00c6a21d2281;hb=79e7db5ed279548bc4b862cd402807ff0e7d8209;hpb=11665c1b3741eaf7c4cc51f54ce7c5b8f8467f18 diff --git a/README.md b/README.md index a7d8e30..b696a29 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ A simple way to turn any command into a shell with arrow key/history support. This is a fork of [taskshell](https://github.com/GothenburgBitFactory/taskshell) with a highly reduce codebase. ## Usage -Just put the command that you want to repeat after `gen-shell`, eg; `gen-shell ls`, or even something much more complex like `gen-shell "cd /home/armaa/Clone/words && /home/armaa/Clone/words/bin/words` This command was actually the inspiration for gen-shell. +Just put the command that you want to repeat after the c flag, eg; `gen-shell -c ls`, or even something much more complex like `gen-shell -c "cd /home/armaa/Clone/words && /home/armaa/Clone/words/bin/words` This command was actually the inspiration for gen-shell. ## Installation ### Binaries @@ -17,8 +17,14 @@ If you would like to avoid this, you can build from source. Doing so requires: - g++ (sometimes packaged as gcc-c++ or gcc-g++) - cpp (11 or higher) - libreadline development files (7 or 8 is fine, 5 is untested) + +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 +``` + ```bash -git clone https://codeberg.org/armaan/gen-shell +git clone --recursive https://codeberg.org/armaan/gen-shell cd gen-shell cmake . make @@ -32,11 +38,11 @@ You can also run gen-shell in docker. Simply use ```bash docker run -it -e CMD= armaanb/gen-shell:latest ``` -Or to build the docker container locally +Or to build the docker container locally, which ensures that you are using the latest version, or lets you make changes to the source code before building: ```bash -git clone https://codeberg.org/armaan/gen-shell +git clone --recursive https:/codeberg.org/armaan/gen-shell cd gen-shell -docker build -t armaanb/gen-shell:latest . +docker build --no-cache -t armaanb/gen-shell:latest . docker run -it -e CMD= armaanb/gen-shell ``` ## License