ahamilton/eris
1
0
Fork 0
Code Releases Activity

Make it easier to copy & paste from the Readme.

Browse source
This commit is contained in:
Andrew Hamilton 2021-12-21 19:01:32 +10:00
parent 3ffeae2aee
commit cc69e00889
2 changed files with 38 additions and 38 deletions
Download patch file Download diff file Expand all files Collapse all files

38
README.md
View file

@ -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: 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
# eris --apt-install-tools eris --apt-install-tools
Or install from source: (including tools) Or install from source: (including tools)
# git clone https://github.com/ahamilton/eris git clone https://github.com/ahamilton/eris
# cd eris cd eris
# ./install ./install
Then to run: Then to run:
# eris -h eris -h
# eris-webserver <project> # Or a simple web interface. eris-webserver <project> # Or a simple web interface.
#### Docker #### Docker
# git clone https://github.com/ahamilton/eris git clone https://github.com/ahamilton/eris
# 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
#### 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
# 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
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" 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
## Tools ## Tools

38
packaging/make-readme.py
View file

@ -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: 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
# eris --apt-install-tools eris --apt-install-tools
Or install from source: (including tools) Or install from source: (including tools)
# git clone https://github.com/ahamilton/eris git clone https://github.com/ahamilton/eris
# cd eris cd eris
# ./install ./install
Then to run: Then to run:
# eris -h eris -h
# eris-webserver <project> # Or a simple web interface. eris-webserver <project> # Or a simple web interface.
#### Docker #### Docker
# git clone https://github.com/ahamilton/eris git clone https://github.com/ahamilton/eris
# 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
#### 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
# 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
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" 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
## Tools ## Tools