🧹 cleanup the docs

This commit is contained in:
Vladislav Nepogodin 2022-08-13 02:34:17 +04:00
parent a75e8d8cb1
commit dbf3e33406
No known key found for this signature in database
GPG Key ID: B62C3D10C54D5DA9

View File

@ -7,7 +7,7 @@ Also included is an example configuration for each setting. If you don't want to
thinking about options, the config as generated sets sensible defaults for all values. Do note however that the thinking about options, the config as generated sets sensible defaults for all values. Do note however that the
config is used only for the "Simple Install". config is used only for the "Simple Install".
Sample config is located at `https://github.com/cachyos/new-cli-installer/settings.json`. Sample config is located at `https://github.com/cachyos/new-cli-installer/blob/master/settings.json`.
The config file(`settings.json`) must be placed in the current directory. The config file(`settings.json`) must be placed in the current directory.
for example: if going to launch installer in `/root`, then the config must be placed at `/root/settings.json`. for example: if going to launch installer in `/root`, then the config must be placed at `/root/settings.json`.
@ -106,10 +106,10 @@ Example configuration:
This sets the mount options to mount `device` with. This sets the mount options to mount `device` with.
Default to: Default to:
* btrfs: "compress=lzo,noatime,space_cache,ssd,commit=120" * `btrfs`: "compress=lzo,noatime,space_cache,ssd,commit=120"
* ext4: "noatime" * `ext4`: "noatime"
* xfs: no defaults for that filesystem * `xfs`: no defaults for that filesystem
* zfs: this option is invalid for ZFS * `zfs`: this option is invalid for ZFS
Example configuration: Example configuration:
```json ```json
@ -253,17 +253,17 @@ This will install desktop environment.
Required in `HEADLESS` mode! Required in `HEADLESS` mode!
Valid `desktop`: Valid `desktop`:
* kde * `kde`
* cutefish * `cutefish`
* xfce * `xfce`
* sway * `sway`
* wayfire * `wayfire`
* i3wm * `i3wm`
* gnome * `gnome`
* openbox * `openbox`
* bspwm * `bspwm`
* Kofuku edition * `Kofuku edition`
* lxqt * `lxqt`
There is no default for this option. There is no default for this option.
@ -278,13 +278,13 @@ This will specified bootloader on the system.
Required in `HEADLESS` mode! Required in `HEADLESS` mode!
Valid `bootloader` for UEFI system: Valid `bootloader` for UEFI system:
* systemd-boot * `systemd-boot`
* grub * `grub`
* refind * `refind`
Valid `bootloader` for BIOS system: Valid `bootloader` for BIOS system:
* grub * `grub`
* grub + os-prober * `grub + os-prober`
There is no default for this option. There is no default for this option.
@ -298,8 +298,8 @@ Example configuration:
This will detect drivers automatically and install them. This will detect drivers automatically and install them.
Valid types: Valid types:
* nonfree * `nonfree`
* free * `free`
Defaults to `free`. Defaults to `free`.