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 4, 2025
1 parent 897a715 commit 538722b
Showing 1 changed file with 30 additions and 0 deletions.
30 changes: 30 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,35 @@ 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


## Via latest release from PyPI

- a) `pipx install image-bootstrap`

- b) `pip3 install --user --break-system-packages image-bootstrap`


## Via Git `HEAD`

- a) `pipx install git+https://github.com/hartwork/image-bootstrap`

- b) `pip3 install --user --break-system-packages git+https://github.com/hartwork/image-bootstrap`


## Extending `${PATH}`

For commands `image-bootstrap` and `directory-bootstrap` to be found, you'll need to extend `${PATH}`, e.g.:

```bash
export PATH="${PATH}:${HOME}/.local/bin" # one-time or via ~/.bashrc

image-bootstrap --help
```


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

Expand Down

0 comments on commit 538722b

Please sign in to comment.