From a8b01ae0da4c55cb1e4229ecf20c1cfdebe4b49d Mon Sep 17 00:00:00 2001 From: InsanePrawn Date: Sun, 6 Feb 2022 04:37:42 +0100 Subject: [PATCH] README: add usage instructions --- README.md | 14 +++++++++++--- 1 file changed, 11 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 11f1cc8..d197b07 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,16 @@ # kupferbootstrap -## Install -Install Docker and Python 3 and put `bin/` into your `PATH`. +Kupfer Linux bootstrapping tool - drives pacstrap, makepkg, mkfs and fastboot, just to name a few. + +## Installation +Install Docker, Python 3 with libraries `click`, `appdirs`, `joblib`, `toml` and put `bin/` into your `PATH`. Then use `kupferbootstrap`. -## Develop +## Usage +1. Initialise config with defaults: `kupferbootstrap config init -N` +1. Configure your device profile: `kupferbootstrap config profile init` +1. Build an image and packages along the way: `kupferbootstrap image build` + + +## Development Put `dev` into `version.txt` to always rebuild kupferboostrap from this directory and use `kupferbootstrap` as normal.