From f3ae67039508fa6909588dcd69f4bda94fd9d27e Mon Sep 17 00:00:00 2001
From: Blake Romero <blake@blkrom.com>
Date: Fri, 20 Sep 2024 14:06:31 +0100
Subject: Update README & convert text to org file

---
 README.org | 60 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 60 insertions(+)
 create mode 100644 README.org

(limited to 'README.org')

diff --git a/README.org b/README.org
new file mode 100644
index 0000000..e2eda08
--- /dev/null
+++ b/README.org
@@ -0,0 +1,60 @@
+#+title: Artix Linux Installation
+#+options: num:nil
+
+* Introduction
+The installation script provides an [[https://artixlinux.org][Artix Linux]] distribution with BTRFS and minimal packages.
+Follow the setup process bellow to install it onto a system.
+
+* Setup
+1. boot up a system with an [[https://artixlinux.org/download.php][Artix Linux ISO]] (it must be a dinit base image)
+2. login as =root= with password =artix=
+3. ensure system is connected to the internet
+4. download git & a text editor (e.g. =pacman -Syy git nano=)
+5. clone this repository onto the system
+6. configure options in the =config= file
+7. run =install.sh= to begin installation
+
+* Notes
+- default root password is =artix=
+- decryption password is the =user= password
+- UEFI is supported but not BIOS at the moment
+
+* Example System Layout
+#+begin_example
+  +--------------------------------------------------+
+  | Device              | Label | Mount       | Size |
+  |--------------------------------------------------|
+  | /dev/sda            |       |             |      |
+  | ├─/dev/sda1         | BOOT  | /boot       | 512M |
+  | └─/dev/sda2         | ROOT  |             |  MAX |
+  |   └─@               |       | /           |      |
+  |   └─@home           |       | /home       |      |
+  |   └─@tmp            |       | /tmp        |      |
+  |   └─@var            |       | /var        |      |
+  |   └─@snapshots      |       | /.snapshots |      |
+  |   └─@swap           | SWAP  | /.swap      | AUTO |
+  +--------------------------------------------------+
+#+end_example
+
+* Configuration Options
+Configuration options are available in the =config= file.
+
+| Option       | Example        | Notes                                            |
+|--------------+----------------+--------------------------------------------------|
+| =drive=        | /dev/sda       | main device for installation                     |
+| =boot=         | /dev/sda1      | can be already in use if =duel_boot= is enabled    |
+| =root=         | /dev/sda2      | will use BTRFS with dedicated subvolumes         |
+| =swap_size=    | auto           | can be set explicitly, e.g. =8G= or =16G=            |
+| =boot_size=    | 512M           | set a large value if duel booting, e.g. =1G=       |
+| =duel_boot=    | true           | =boot= must be already setup & separate from =drive= |
+| =timezone=     | Europe/London  | timezones are defined in =/usr/share/zoneinfo/=    |
+| =locale=       | en_GB          | locales are defined in =/etc/locale.gen=           |
+| =user=         | blake          | the main user of the system                      |
+| =user_groups=  | wheel,log,seat | groups for =user=, see [[https://wiki.archlinux.org/title/Users_and_groups#Group_list][ArchWiki]] for more info      |
+| =hostname=     | ArtixPC        | the system name                                  |
+| =arch_support= | false          | enables extra & multilib repositories            |
+| =enable_aur=   | false          | installs the =trizen= AUR helper                   |
+| =autologin=    | false          | automatically login system                       |
+
+* Notes
+Last tested using =artix-base-dinit-20240823-x86_64.iso= on a UEFI system.
-- 
cgit