From 69bed9fc4efa6c5dcf49730feaca796a74fdad9a Mon Sep 17 00:00:00 2001 From: InsanePrawn Date: Sun, 4 Sep 2022 04:34:32 +0200 Subject: [PATCH] readme: point to online kupfer docs, use full config init instead of non-interactive --- README.md | 23 +++++++++++++++++++---- 1 file changed, 19 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index b2d9f4d..61e6949 100644 --- a/README.md +++ b/README.md @@ -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`