summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorBlake Romero <blake@blkrom.com>2023-05-25 13:04:52 +0100
committerBlake Romero <blake@blkrom.com>2023-05-25 13:04:52 +0100
commitda6aa07f0f74f1044b7345c9a622b8ea32b15515 (patch)
tree7ca9873c8570fa01de494a721c14cbe6dd294a8d /README
parentbe7158d5b025209dd4a348a393987f871c316fc6 (diff)
Update README with options
Diffstat (limited to 'README')
-rw-r--r--README44
1 files changed, 22 insertions, 22 deletions
diff --git a/README b/README
index a7e79bd..f44a985 100644
--- a/README
+++ b/README
@@ -30,35 +30,35 @@ SYSTEM LAYOUT:
+---------------------------------------------------+
CONFIGURATION:
-- drive :the drive to perform the installation
+- drive: the drive to perform the installation.
+- boot: the boot partition.
+- swap: the swap partition.
+- root: the root partition (which will be encrypted).
-- boot: the boot partition
-
-- swap: the swap partition
-
-- root: the root partition (which will be encrypted)
-
-- timezone: a timezone (defined in '/usr/share/zoneinfo/')
-
-- locale: a locale (defined in '/etc/locale.gen')
-
-- user: the main user of the system
+- swap_size: defaults to auto, but can be overwritten
+ e.g: 'swap_size=8G'.
-- user_groups: the groups for 'user' belongs to
+- boot_size: Defaults to 512M. Can be overwritten
+ e.g: 'boot_size=1G'.
-- hostname: the hostname of the system
+- timezone: a timezone (defined in '/usr/share/zoneinfo/').
+- locale: a locale (defined in '/etc/locale.gen').
+- user: the main user of the system.
+- user_groups: the groups 'user' belongs to.
+- hostname: the hostname of the system.
-- arch_support: whether enable Arch repositories
+- arch_support: whether to enable Arch repositories.
(enables extra, community, & multilib)
-- enable_aur: specifies whether to install an AUR helper
- (uses trizen as AUR helper)
+- enable_aur: specifies whether to install an AUR helper.
+ (installs trizen AUR helper)
-- swap_size: Defaults to formula, but can be overwritten
- e.g: 'swap_size=8G'.
-
-- boot_size: Defaults to 512M. Can be overwritten
- in CONFIG e.g: boot_size=1G.
+- autologin: automatically login to user after unlocking drive.
+ User password must match decryption password; this is
+ the default behaviour when installing, however if you
+ update your password be sure to update the decryption
+ password to match, or remove '--autologin USER' from
+ '/etc/runit/sv/agetty-tty1/conf' to disable this behaviour.
NOTES
Last tested using 'artix-base-runit-20230501-x86_64.iso' on UEFI \ No newline at end of file