Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
white-gecko authored Dec 31, 2023
1 parent 830cc6b commit c6312e7
Showing 1 changed file with 14 additions and 1 deletion.
15 changes: 14 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,10 +22,23 @@ by Natanael Arndt, Patrick Naumann, Norman Radtke, Michael Martin, and Edgard Ma

To get the Quit Store you have three options:

- Download a binary from https://github.com/AKSW/QuitStore/releases (Currently works for amd64 Linux)
- Install via [pipx](https://pipx.pypa.io/)
- Clone it with Git from our repository: https://github.com/AKSW/QuitStore
- Use Docker and see the section [Docker](#docker) in the README

- The binary self-contained releasses created with [pyinstaller](https://pyinstaller.org/) are currently broken [#291](https://github.com/AKSW/QuitStore/issues/291) and [#302](https://github.com/AKSW/QuitStore/issues/302). I'm happy about help.

### Installation via pipx

```
$ pipx install git+https://github.com/AKSW/QuitStore.git
installed package quit 0.25.4, installed using Python 3.12.1
These apps are now globally available
- quitstore
done! ✨ 🌟 ✨
$ quitstore --help
```

### Installation from Source

Install [poetry](https://python-poetry.org/).
Expand Down

0 comments on commit c6312e7

Please sign in to comment.