From 3b29fb3c10d68f36cd55fbc07c999ea29d478725 Mon Sep 17 00:00:00 2001 From: Andrew Hamilton Date: Tue, 21 Dec 2021 13:00:31 +1000 Subject: [PATCH] Better formatting in Readme. --- README.md | 7 +++++-- packaging/make-readme.py | 7 +++++-- 2 files changed, 10 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 527988a..abd7720 100644 --- a/README.md +++ b/README.md @@ -18,7 +18,10 @@ Eris maintains an up-to-date set of reports for every file in a codebase. # git clone https://github.com/ahamilton/eris # cd eris # ./install + + Then to run: # eris -h + or the webserver: # eris-webserver ### Docker @@ -31,7 +34,7 @@ Eris maintains an up-to-date set of reports for every file in a codebase. ### Snap - # Download snap file from github releases page: + 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 @@ -40,7 +43,7 @@ Eris maintains an up-to-date set of reports for every file in a codebase. ### AppImage - # Download AppImage file from github releases page: + 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 diff --git a/packaging/make-readme.py b/packaging/make-readme.py index fb91d5b..406453a 100755 --- a/packaging/make-readme.py +++ b/packaging/make-readme.py @@ -34,7 +34,10 @@ Eris maintains an up-to-date set of reports for every file in a codebase. # git clone https://github.com/ahamilton/eris # cd eris # ./install + + Then to run: # eris -h + or the webserver: # eris-webserver ### Docker @@ -47,7 +50,7 @@ Eris maintains an up-to-date set of reports for every file in a codebase. ### Snap - # Download snap file from github releases page: + 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 @@ -56,7 +59,7 @@ Eris maintains an up-to-date set of reports for every file in a codebase. ### AppImage - # Download AppImage file from github releases page: + 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