readme: point to online kupfer docs, use full config init instead of non-interactive

This commit is contained in:
InsanePrawn 2022-09-04 04:34:32 +02:00
parent b80f42d48a
commit 69bed9fc4e

View file

@ -1,14 +1,29 @@
# kupferbootstrap
Kupfer Linux bootstrapping tool - drives pacstrap, makepkg, mkfs and fastboot, just to name a few.
Kupfer Linux bootstrapping tool - drives pacstrap, makepkg, chroot, mkfs and fastboot, just to name a few.
## Documentation
Detailed docs for the main branch are available online at https://kupfer.gitlab.io/kupferbootstrap/
You can also build and view the docs locally:
```sh
cd docs/ && \
make && \
make serve
```
This will run a webserver on localhost:9999. Access it like `firefox http://localhost:9999/`
## Installation
Install Docker, Python 3 with the libraries from `requirements.txt` and put `bin/` into your `PATH`.
Then use `kupferbootstrap`.
## Usage
1. Initialize config with defaults: `kupferbootstrap config init -N`
1. Configure your device profile: `kupferbootstrap config profile init`
## Quickstart
1. Initialize config with defaults, configure your device and flavour: `kupferbootstrap config init`
1. Build an image and packages along the way: `kupferbootstrap image build`