mirror of
https://github.com/ihabunek/toot
synced 2025-01-18 04:16:16 +01:00
Update installation instructions
This commit is contained in:
parent
3969a15029
commit
707b6e0ca7
@ -1,22 +1,61 @@
|
|||||||
Installation
|
Installation
|
||||||
============
|
============
|
||||||
|
|
||||||
|
## Package repositories
|
||||||
|
|
||||||
toot is packaged for various platforms. If possible use your OS's package manager to install toot.
|
toot is packaged for various platforms. If possible use your OS's package manager to install toot.
|
||||||
|
|
||||||
[![Packaging status](https://repology.org/badge/vertical-allrepos/toot.svg)](https://repology.org/project/toot/versions)
|
<details>
|
||||||
|
<summary>Packaging status</summary>
|
||||||
## Python Package Index
|
<a href="https://repology.org/project/toot/versions" style="display: block; margin-top: 2rem">
|
||||||
|
<img src="https://repology.org/badge/vertical-allrepos/toot.svg" alt="Packaging status" />
|
||||||
Install from PyPI using pip, preferably into a virtual environment.
|
</a>
|
||||||
|
</details>
|
||||||
pip install toot
|
|
||||||
|
|
||||||
## Homebrew
|
## Homebrew
|
||||||
|
|
||||||
For Mac OSX users, toot is available [in homebrew](https://formulae.brew.sh/formula/toot#default).
|
For Mac users, toot is available [in homebrew](https://formulae.brew.sh/formula/toot#default).
|
||||||
|
|
||||||
brew install toot
|
brew install toot
|
||||||
|
|
||||||
|
## Using pipx
|
||||||
|
|
||||||
|
pipx installs packages from PyPI into isolated environments. It is the
|
||||||
|
recommended installation method if there is no OS package or the package is
|
||||||
|
outdated.
|
||||||
|
|
||||||
|
Firstly, install pipx following their [installation instructions](https://pipx.pypa.io/stable/installation/).
|
||||||
|
|
||||||
|
Install toot:
|
||||||
|
|
||||||
|
pipx install toot
|
||||||
|
|
||||||
|
Install with optional image support:
|
||||||
|
|
||||||
|
pipx install "toot[images]"
|
||||||
|
|
||||||
|
Upgrade to latest version:
|
||||||
|
|
||||||
|
pipx upgrade toot
|
||||||
|
|
||||||
## From source
|
## From source
|
||||||
|
|
||||||
You can get the latest source distribution [from Github](https://github.com/ihabunek/toot/releases/latest/).
|
You can get the latest source distribution [from Github](https://github.com/ihabunek/toot/releases/latest/).
|
||||||
|
|
||||||
|
Clone the project and install into a virtual environment.
|
||||||
|
|
||||||
|
```
|
||||||
|
git clone git@github.com:ihabunek/toot.git
|
||||||
|
cd toot
|
||||||
|
python3 -m venv .venv
|
||||||
|
source .venv/bin/activate
|
||||||
|
pip install .
|
||||||
|
```
|
||||||
|
|
||||||
|
After this, the executable is available at `.venv/bin/toot`.
|
||||||
|
|
||||||
|
To install with optonal image support:
|
||||||
|
|
||||||
|
```
|
||||||
|
pip install ".[images]"
|
||||||
|
```
|
Loading…
Reference in New Issue
Block a user