docs: move usage guides to usage/, add quickstart and porting
This commit is contained in:
parent
2e504b7b00
commit
ff8a529690
7 changed files with 155 additions and 5 deletions
32
docs/source/usage/install.md
Normal file
32
docs/source/usage/install.md
Normal file
|
@ -0,0 +1,32 @@
|
|||
# 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`!
|
Loading…
Add table
Add a link
Reference in a new issue