Skip to content

Commit

Permalink
README.md: Document options for installation
Browse files Browse the repository at this point in the history
  • Loading branch information
hartwork committed Jan 3, 2025
1 parent 3bbc408 commit bb238d8
Showing 1 changed file with 42 additions and 0 deletions.
42 changes: 42 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@

* [About](#About)
* [History](#History)
* [Installation](#Installation)
* [Example run](#ExampleRun)
* [Speeding things up](#SpeedingThingsUp)
* [Using RAM instead of HDD/SSD](#UsingRamInsteadOfDisk)
Expand Down Expand Up @@ -89,6 +90,47 @@ Support for Void Linux ~and CentOS~ chroots came into live during 34c3, December
Support for Alpine Linux chroots came into in March 2018.


<a name="Installation"></a>
# Installation

There are many ways to install Python software onto your system
and its hard to predict which option fits your environment best.
In general there are three options:

- a) install using a package of your distribution (if they have some)
- b) install from PyPI directly (more on that below)
- c) install from a Git clone (mostly during development)

For installing the latest release from PyPI your main options are:


## A) `pipx install`

```bash
pipx install image-bootstrap
export PATH="${PATH}:${HOME}/.local/bin"
image-bootstrap --help
```


## B) `pip3 install` + virtual environment

```bash
python3 -m venv venv/
venv/bin/pip3 install image-bootstrap
venv/bin/image-bootstrap --help
```


## C) `pip3 install [--user]` (does *not* work in Ubuntu/Debian/Gentoo/..)

```bash
pip3 install --user image-bootstrap
export PATH="${PATH}:${HOME}/.local/bin"
image-bootstrap --help
```


<a name="ExampleRun"></a>
# Example run

Expand Down

0 comments on commit bb238d8

Please sign in to comment.