README: add usage instructions

This commit is contained in:
InsanePrawn 2022-02-06 04:37:42 +01:00
parent 531845f176
commit a8b01ae0da

View file

@ -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.