update readme

This commit is contained in:
JMARyA 2025-01-08 21:07:07 +01:00
parent 26cd7c264c
commit 59203d9085
Signed by: jmarya
GPG key ID: 901B2ADDF27C2263

View file

@ -2,9 +2,10 @@
navOS Installer navOS Installer
## Create install medium ## Create install medium
You can create a bootable install medium either with or without GUI: You can create a bootable install medium with various predefined options:
```sh ```sh
navinstall create-iso [--without_gui] navinstall create-iso [--without_gui] [--kb_layout <LAYOUT>] [--kb_variant <VARIANT>]
``` ```
## Install a system ## Install a system
@ -15,3 +16,12 @@ navinstall install config.toml
`config.toml` is a system configuration describing how to install the system. `config.toml` is a system configuration describing how to install the system.
Example configurations can be found [here](installs) or at `/usr/share/navinstall/installs/`. Example configurations can be found [here](installs) or at `/usr/share/navinstall/installs/`.
## Create an unattended installer
You can create an install medium which immidiately upon boot installs a configuration:
```sh
navinstall create-iso --install config.toml
```
> <b style="color:orange">⚠️ WARNING</b>: This is potentially destructive and will probably wipe all data on the disks if randomly booted from.