From 0fcea84b6cbc91f3f24b608b0b07aa796e560372 Mon Sep 17 00:00:00 2001 From: Tommaso Chiti Date: Mon, 1 Feb 2021 13:24:31 +0100 Subject: [PATCH] Docs. --- README.md | 20 +++++++++++--------- 1 file changed, 11 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 0a58cd9..0d6a79a 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ ### Introduction -easy-arch is a script made in order to boostrap a basic Arch Linux environment with snapshots and encryption by using a fully automated process. +[easy-arch](https://github.com/classy-giraffe/easy-arch) is a **script** made in order to boostrap a basic **Arch Linux** environment with **snapshots** and **encryption** by using a fully automated process. ### Partitions layout @@ -8,9 +8,9 @@ easy-arch is a script made in order to boostrap a basic Arch Linux environment w | 1 | ESP | 512 MiB | /boot | FAT32 | | 2 | Cryptroot | Rest of the disk | / | BTRFS Encrypted (LUKS) | -The partitions layout is pretty straightforward, it's inspired by [this section](https://wiki.archlinux.org/index.php/Dm-crypt/Encrypting_an_entire_system#Btrfs_subvolumes_with_swap) of the Arch Wiki. As you can see there's just a couple of partitions: -1. A FAT32, 512MiB sized, mounted at `/boot` for the ESP. -2. A LUKS encrypted container, which takes the rest of the disk mounted at `/` for the rootfs. +The **partitions layout** is pretty straightforward, it's inspired by [this section](https://wiki.archlinux.org/index.php/Dm-crypt/Encrypting_an_entire_system#Btrfs_subvolumes_with_swap) of the Arch Wiki. As you can see there's just a couple of partitions: +1. A **FAT32**, 512MiB sized, mounted at `/boot` for the ESP. +2. A **LUKS encrypted container**, which takes the rest of the disk mounted at `/` for the rootfs. ### BTRFS subvolumes layout @@ -22,7 +22,7 @@ The partitions layout is pretty straightforward, it's inspired by [this section] | 4 | @var_log | /var/log | | 5 | @swap | /swap (optional) | -The BTRFS subvolumes layout follows the traditional and suggested layout used by Snapper, you can find it [here](https://wiki.archlinux.org/index.php/Snapper#Suggested_filesystem_layout). I only added a swap subvolume in case you need a swapfile, but it's totally optional. You'll be asked if you want it or not during the script execution. Here's a brief explanation of the BTRFS layout I chose: +The **BTRFS subvolumes layout** follows the traditional and suggested layout used by **Snapper**, you can find it [here](https://wiki.archlinux.org/index.php/Snapper#Suggested_filesystem_layout). I only added a swap subvolume in case you need a swapfile, but it's totally optional. You'll be asked if you want it or not during the script execution. Here's a brief explanation of the **BTRFS layout** I chose: 1. `@` mounted as `/`. 2. `@home` mounted as `/home`. 3. `@snapshots` mounted as `/.snapshots`. @@ -30,7 +30,9 @@ The BTRFS subvolumes layout follows the traditional and suggested layout used by 5. `@swap` mounted as `/swap` (_optional_). ### How does it work? -1. Boot into the archiso. -2. Set the keyboard layout by using `loadkeys`. -3. Connect to the internet. -4. Run this `sh <(curl -sL u.nu/ws5e2)`. +1. Download an Arch Linux ISO from [here](https://archlinux.org/download/) +2. Flash the ISO onto an [USB Flash Drive](https://wiki.archlinux.org/index.php/USB_flash_installation_medium). +3. Boot the live environment. +4. Set the keyboard layout by using `loadkeys`. +5. Connect to the internet. +6. Run this `sh <(curl -sL u.nu/ws5e2)`.