diff --git a/README.md b/README.md index 6e33c66..913ab6f 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,49 @@ # arch-zbm -Helper script to install Arch Linux with ZFSBootMenu \ No newline at end of file +Helper script to install Arch Linux with ZFSBootMenu from within a running Arch live CD ISO image + +# Prep + +The script expects minimal prep on your end. Please make sure that before execution at least one of the following conditions are met. + +- Your machine has exactly one partition with partition type code `BF00` ("Solaris root") + +# How to run this? + +- Boot an Arch Linux live CD ISO image +- Run: + ``` + curl -s https://quico.space/hygienic-books/config-jetbrains-ides/raw/branch/master/colors.scheme.xml | bash + ``` + +# Steps + +The scripts takes the following installation steps. + +1. Install ZFS with [github.com/eoli3n/archiso-zfs](https://github.com/eoli3n/archiso-zfs) + +# Assumptions + +# Development + +## Conventional commits + +This project uses [Conventional Commits](https://www.conventionalcommits.org/) for its commit messages. + +### Commit types + +Commit _types_ besides `fix` and `feat` are: + +* `build`: Project structure, directory layout, build instructions for roll-out +* `refactor`: Keeping functionality while streamlining or otherwise improving function flow +* `test`: Working on test coverage +* `docs`: Documentation for project or components + +### Commit scopes + +The following _scopes_ are known for this project. A Conventional Commits commit message may optionally use one of the following scopes or none: + +* `zbm`: Adjusting ZFSBootMenu's behavior +* `zfs`: A change to how ZFS interacts with the system, either a pool or a dataset +* `os`: Getting an perating system set up to correctly work in a ZFS boot environment +* `meta`: Affects the project's repo layout, readme content, file names etc.