mirror of
https://gitlab.com/kupfer/kupferbootstrap.git
synced 2025-02-23 21:55:43 -05:00
33 lines
1,012 B
Markdown
33 lines
1,012 B
Markdown
|
# Installation
|
||
|
|
|
||
|
|
1. Install Python 3, Docker, and git.
|
||
|
|
|
||
|
|
On Arch: `pacman -S python docker git --needed --noconfirm`
|
||
|
|
|
||
|
|
```{Hint}
|
||
|
|
After installing Docker you will have to add your user to the `docker` group:
|
||
|
|
|
||
|
|
`sudo usermod -aG docker "$(whoami)"`
|
||
|
|
|
||
|
|
Then restart your desktop session for the new group to take effect.
|
||
|
|
```
|
||
|
|
|
||
|
|
2. Pick which Kupferbootstrap branch to clone: usually either `main` or `dev`
|
||
|
|
|
||
|
|
3. Clone the repository: `git clone -b INSERT_BRANCHNAME_HERE https://gitlab.com/kupfer/kupferbootstrap`
|
||
|
|
|
||
|
|
4. Change into the folder: `cd kupferbootstrap`
|
||
|
|
|
||
|
|
5. Install python dependencies: `pip3 install -r requirements.txt`
|
||
|
|
|
||
|
|
```{Note}
|
||
|
|
Most of our python dependencies are available as distro packages on most distros,
|
||
|
|
sadly it's incomplete on Arch.
|
||
|
|
|
||
|
|
See `requirements.txt` for the list of required python packages.
|
||
|
|
```
|
||
|
|
|
||
|
|
6. Symlink `kupferbootstrap` into your `$PATH`: `sudo ln -s "$(pwd)/bin/kupferbootstrap" /usr/local/bin/`
|
||
|
|
|
||
|
|
7. You should now be able to run `kupferbootstrap --help`!
|