Improve Readme.
- Remove redundant lines. - Break up instructions into subsections. - Easier to copy commands. - Brief comment on webserver.
This commit is contained in:
parent
3b29fb3c10
commit
0a08155880
2 changed files with 8 additions and 22 deletions
11
README.md
11
README.md
|
|
@ -8,10 +8,8 @@ Eris maintains an up-to-date set of reports for every file in a codebase.
|
||||||
|
|
||||||
### Ubuntu (21.10)
|
### 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
|
# 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
|
# eris --apt-install-tools
|
||||||
|
|
||||||
Or install from source: (including tools)
|
Or install from source: (including tools)
|
||||||
|
|
@ -21,8 +19,7 @@ Eris maintains an up-to-date set of reports for every file in a codebase.
|
||||||
|
|
||||||
Then to run:
|
Then to run:
|
||||||
# eris -h
|
# eris -h
|
||||||
or the webserver:
|
# eris-webserver <project> # Or a simple webserver interface
|
||||||
# eris-webserver <project>
|
|
||||||
|
|
||||||
### Docker
|
### Docker
|
||||||
|
|
||||||
|
|
@ -30,15 +27,12 @@ Eris maintains an up-to-date set of reports for every file in a codebase.
|
||||||
# cd eris
|
# cd eris
|
||||||
# sudo docker build -t eris -f packaging/Dockerfile .
|
# sudo docker build -t eris -f packaging/Dockerfile .
|
||||||
# cp packaging/eris-docker ~/bin/eris # e.g. Put wrapper script in your PATH
|
# cp packaging/eris-docker ~/bin/eris # e.g. Put wrapper script in your PATH
|
||||||
# eris -h
|
|
||||||
|
|
||||||
### Snap
|
### 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"
|
# 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
|
# snap install --dangerous eris_2021.12.06_amd64.snap
|
||||||
# eris -h
|
|
||||||
# eris.webserver <project>
|
|
||||||
# rm eris_2021.12.06_amd64.snap # The snap file is no longer needed.
|
# rm eris_2021.12.06_amd64.snap # The snap file is no longer needed.
|
||||||
|
|
||||||
### AppImage
|
### 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"
|
# wget "https://github.com/ahamilton/eris/releases/download/v2021-12-06/eris_2021.12.06.AppImage"
|
||||||
# chmod +x 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
|
# mv eris_2021.12.06.AppImage ~/bin/eris # e.g. Put appimage in your PATH
|
||||||
# eris -h
|
|
||||||
|
|
||||||
## Tools
|
## Tools
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -24,10 +24,8 @@ Eris maintains an up-to-date set of reports for every file in a codebase.
|
||||||
|
|
||||||
### Ubuntu (21.10)
|
### 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
|
# 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
|
# eris --apt-install-tools
|
||||||
|
|
||||||
Or install from source: (including tools)
|
Or install from source: (including tools)
|
||||||
|
|
@ -37,8 +35,7 @@ Eris maintains an up-to-date set of reports for every file in a codebase.
|
||||||
|
|
||||||
Then to run:
|
Then to run:
|
||||||
# eris -h
|
# eris -h
|
||||||
or the webserver:
|
# eris-webserver <project> # Or a simple webserver interface
|
||||||
# eris-webserver <project>
|
|
||||||
|
|
||||||
### Docker
|
### Docker
|
||||||
|
|
||||||
|
|
@ -46,15 +43,12 @@ Eris maintains an up-to-date set of reports for every file in a codebase.
|
||||||
# cd eris
|
# cd eris
|
||||||
# sudo docker build -t eris -f packaging/Dockerfile .
|
# sudo docker build -t eris -f packaging/Dockerfile .
|
||||||
# cp packaging/eris-docker ~/bin/eris # e.g. Put wrapper script in your PATH
|
# cp packaging/eris-docker ~/bin/eris # e.g. Put wrapper script in your PATH
|
||||||
# eris -h
|
|
||||||
|
|
||||||
### Snap
|
### 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"
|
# 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
|
# snap install --dangerous eris_2021.12.06_amd64.snap
|
||||||
# eris -h
|
|
||||||
# eris.webserver <project>
|
|
||||||
# rm eris_2021.12.06_amd64.snap # The snap file is no longer needed.
|
# rm eris_2021.12.06_amd64.snap # The snap file is no longer needed.
|
||||||
|
|
||||||
### AppImage
|
### 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"
|
# wget "https://github.com/ahamilton/eris/releases/download/v2021-12-06/eris_2021.12.06.AppImage"
|
||||||
# chmod +x 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
|
# mv eris_2021.12.06.AppImage ~/bin/eris # e.g. Put appimage in your PATH
|
||||||
# eris -h
|
|
||||||
|
|
||||||
## Tools
|
## Tools
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue