From 0a081558802ad7bc102ef073c012e9c8d28a84d2 Mon Sep 17 00:00:00 2001 From: Andrew Hamilton Date: Tue, 21 Dec 2021 13:09:51 +1000 Subject: [PATCH] Improve Readme. - Remove redundant lines. - Break up instructions into subsections. - Easier to copy commands. - Brief comment on webserver. --- README.md | 15 ++++----------- packaging/make-readme.py | 15 ++++----------- 2 files changed, 8 insertions(+), 22 deletions(-) diff --git a/README.md b/README.md index abd7720..9c42a65 100644 --- a/README.md +++ b/README.md @@ -8,21 +8,18 @@ Eris maintains an up-to-date set of reports for every file in a codebase. ### Ubuntu (21.10) - Install eris directly using pip: +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 - - and apt install the tools eris relies on: # eris --apt-install-tools - Or install from source: (including tools) +Or install from source: (including tools) # git clone https://github.com/ahamilton/eris # cd eris # ./install - Then to run: +Then to run: # eris -h - or the webserver: - # eris-webserver + # eris-webserver # Or a simple webserver interface ### Docker @@ -30,15 +27,12 @@ Eris maintains an up-to-date set of reports for every file in a codebase. # cd eris # sudo docker build -t eris -f packaging/Dockerfile . # cp packaging/eris-docker ~/bin/eris # e.g. Put wrapper script in your PATH - # eris -h ### 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 - # eris -h - # eris.webserver # rm eris_2021.12.06_amd64.snap # The snap file is no longer needed. ### AppImage @@ -47,7 +41,6 @@ Eris maintains an up-to-date set of reports for every file in a codebase. # 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 - # eris -h ## Tools diff --git a/packaging/make-readme.py b/packaging/make-readme.py index 406453a..f21d952 100755 --- a/packaging/make-readme.py +++ b/packaging/make-readme.py @@ -24,21 +24,18 @@ Eris maintains an up-to-date set of reports for every file in a codebase. ### Ubuntu (21.10) - Install eris directly using pip: +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 - - and apt install the tools eris relies on: # eris --apt-install-tools - Or install from source: (including tools) +Or install from source: (including tools) # git clone https://github.com/ahamilton/eris # cd eris # ./install - Then to run: +Then to run: # eris -h - or the webserver: - # eris-webserver + # eris-webserver # Or a simple webserver interface ### Docker @@ -46,15 +43,12 @@ Eris maintains an up-to-date set of reports for every file in a codebase. # cd eris # sudo docker build -t eris -f packaging/Dockerfile . # cp packaging/eris-docker ~/bin/eris # e.g. Put wrapper script in your PATH - # eris -h ### 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 - # eris -h - # eris.webserver # rm eris_2021.12.06_amd64.snap # The snap file is no longer needed. ### AppImage @@ -63,7 +57,6 @@ Eris maintains an up-to-date set of reports for every file in a codebase. # 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 - # eris -h ## Tools