From cc69e0088957ac91a806f27ac4c8e8ca9979e9a8 Mon Sep 17 00:00:00 2001 From: Andrew Hamilton Date: Tue, 21 Dec 2021 19:01:32 +1000 Subject: [PATCH] Make it easier to copy & paste from the Readme. --- README.md | 38 +++++++++++++++++++------------------- packaging/make-readme.py | 38 +++++++++++++++++++------------------- 2 files changed, 38 insertions(+), 38 deletions(-) diff --git a/README.md b/README.md index 6b4dfbb..d3b2441 100644 --- a/README.md +++ b/README.md @@ -10,40 +10,40 @@ Eris maintains an up-to-date set of reports for every file in a codebase. Install eris directly using pip, and apt install the tools eris relies on: - # pip install git+https://github.com/ahamilton/eris@2021.12.20#subdirectory=eris - # eris --apt-install-tools + pip install git+https://github.com/ahamilton/eris@2021.12.20#subdirectory=eris + eris --apt-install-tools Or install from source: (including tools) - # git clone https://github.com/ahamilton/eris - # cd eris - # ./install + git clone https://github.com/ahamilton/eris + cd eris + ./install Then to run: - # eris -h - # eris-webserver # Or a simple web interface. + eris -h + eris-webserver # Or a simple web interface. #### Docker - # git clone https://github.com/ahamilton/eris - # cd eris - # sudo docker build -t eris -f packaging/Dockerfile . - # cp packaging/eris-docker ~/bin/eris # e.g. Put wrapper script in your PATH + git clone https://github.com/ahamilton/eris + cd eris + sudo docker build -t eris -f packaging/Dockerfile . + cp packaging/eris-docker ~/bin/eris # e.g. Put wrapper script in your PATH #### Snap - Download snap file from github releases page: - # wget "https://github.com/ahamilton/eris/releases/download/v2021-12-06/eris_2021.12.06_amd64.snap" - # snap install --dangerous eris_2021.12.06_amd64.snap - # rm eris_2021.12.06_amd64.snap # The snap file is no longer needed. + # Download snap file from github releases page: + wget "https://github.com/ahamilton/eris/releases/download/v2021-12-06/eris_2021.12.06_amd64.snap" + snap install --dangerous eris_2021.12.06_amd64.snap + rm eris_2021.12.06_amd64.snap # The snap file is no longer needed. #### AppImage - Download AppImage file from github releases page: - # wget "https://github.com/ahamilton/eris/releases/download/v2021-12-06/eris_2021.12.06.AppImage" - # chmod +x eris_2021.12.06.AppImage - # mv eris_2021.12.06.AppImage ~/bin/eris # e.g. Put appimage in your PATH + # Download AppImage file from github releases page: + wget "https://github.com/ahamilton/eris/releases/download/v2021-12-06/eris_2021.12.06.AppImage" + chmod +x eris_2021.12.06.AppImage + mv eris_2021.12.06.AppImage ~/bin/eris # e.g. Put appimage in your PATH ## Tools diff --git a/packaging/make-readme.py b/packaging/make-readme.py index da6dff3..387007e 100755 --- a/packaging/make-readme.py +++ b/packaging/make-readme.py @@ -26,40 +26,40 @@ Eris maintains an up-to-date set of reports for every file in a codebase. Install eris directly using pip, and apt install the tools eris relies on: - # pip install git+https://github.com/ahamilton/eris@2021.12.20#subdirectory=eris - # eris --apt-install-tools + pip install git+https://github.com/ahamilton/eris@2021.12.20#subdirectory=eris + eris --apt-install-tools Or install from source: (including tools) - # git clone https://github.com/ahamilton/eris - # cd eris - # ./install + git clone https://github.com/ahamilton/eris + cd eris + ./install Then to run: - # eris -h - # eris-webserver # Or a simple web interface. + eris -h + eris-webserver # Or a simple web interface. #### Docker - # git clone https://github.com/ahamilton/eris - # cd eris - # sudo docker build -t eris -f packaging/Dockerfile . - # cp packaging/eris-docker ~/bin/eris # e.g. Put wrapper script in your PATH + git clone https://github.com/ahamilton/eris + cd eris + sudo docker build -t eris -f packaging/Dockerfile . + cp packaging/eris-docker ~/bin/eris # e.g. Put wrapper script in your PATH #### Snap - Download snap file from github releases page: - # wget "https://github.com/ahamilton/eris/releases/download/v2021-12-06/eris_2021.12.06_amd64.snap" - # snap install --dangerous eris_2021.12.06_amd64.snap - # rm eris_2021.12.06_amd64.snap # The snap file is no longer needed. + # Download snap file from github releases page: + wget "https://github.com/ahamilton/eris/releases/download/v2021-12-06/eris_2021.12.06_amd64.snap" + snap install --dangerous eris_2021.12.06_amd64.snap + rm eris_2021.12.06_amd64.snap # The snap file is no longer needed. #### AppImage - Download AppImage file from github releases page: - # wget "https://github.com/ahamilton/eris/releases/download/v2021-12-06/eris_2021.12.06.AppImage" - # chmod +x eris_2021.12.06.AppImage - # mv eris_2021.12.06.AppImage ~/bin/eris # e.g. Put appimage in your PATH + # Download AppImage file from github releases page: + wget "https://github.com/ahamilton/eris/releases/download/v2021-12-06/eris_2021.12.06.AppImage" + chmod +x eris_2021.12.06.AppImage + mv eris_2021.12.06.AppImage ~/bin/eris # e.g. Put appimage in your PATH ## Tools