README.md in getch-0.7.3 vs README.md in getch-0.11.0
- old
+ new
@@ -8,11 +8,11 @@
[![Ruby Style Guide](https://img.shields.io/badge/code_style-rubocop-brightgreen.svg)](https://github.com/rubocop/rubocop)
![GitHub](https://img.shields.io/github/license/szorfein/getch)
</div>
-A CLI tool to install Gentoo or Void Linux with default:
+A CLI tool to install [Gentoo](https://www.gentoo.org/) (by compiling or in [binary](https://www.gentoo.org/news/2023/12/29/Gentoo-binary.html)) or [Void](https://voidlinux.org/) Linux with default:
+ DNS over HTTPS (with [Quad9](https://www.quad9.net/)).
+ Vim | Nano installed.
+ Iptables installed (not configured).
+ Sudo installed (not configured).
+ [iwd](https://iwd.wiki.kernel.org/) installed if wifi is detected.
@@ -33,11 +33,11 @@
+ Ext4
+ Lvm
+ ZFS
Boot Manager:
-+ **Gentoo**: `BIOS`, `crypted disk` and `musl` will use `Grub2` and `systemd-boot` for `UEFI`.
++ **Gentoo**: Grub2 except on systemd without encryption.
+ **Void**: use only Grub2.
The ISO images i was able to test and that works:
+ [Archlinux](https://www.archlinux.org/download/)
+ [Portia](https://github.com/szorfein/portia/releases): Custom Archiso that includes ZFS support and Ruby.
@@ -45,11 +45,11 @@
* [Voidlinux](https://voidlinux.org/download/)
You can also use your current `linux` host, just pay attention to the disk that will be used.
## Dependencies
-Getch is build without external libs, so it only require `ruby >= 2.5`.
+Getch is build without external libs, so it only require `ruby >= 2.6`.
On a live image of Void, you need to install `xbps-install -S ruby xz gptfdisk
openssl`.
## Install
@@ -71,39 +71,44 @@
# getch -h
After an install by Getch, take a look on the [wiki](https://github.com/szorfein/getch/wiki).
## Examples
-For a french user:
+For a french user on Gentoo:
- # getch --zoneinfo "Europe/Paris" --language fr_FR --keymap fr
+ # getch --disk sda --zoneinfo "Europe/Paris" --language fr_FR --keymap fr
-Install Gentoo on LVM and use a different root disk `/dev/sdc`
+Install Gentoo on LVM and use a different root disk `/dev/vdc`
- # getch --format ext4 --lvm --disk sdc
+ # getch --disk vdc --format ext4 --lvm
-Encrypt your disk with LVM with a french keymap
+Encrypt your disk with LVM with a french keymap and in binary mode:
- # getch --format ext4 --lvm --encrypt --keymap fr
+ # getch --disk sda --format ext4 --lvm --encrypt --keymap fr --binary
Encrypt with ext4 and create a new user `ninja`:
- # getch --format ext4 --encrypt --username ninja
+ # getch --disk vda --format ext4 --encrypt --username ninja
+Change size of root in Gb (default 16 on lvm), swap in Mb (default use your
+current total ram) with lvm.
+
+ # getch --disk sda -o void --lvm --root-size 10 --swap-size 4096
+
With ZFS, if used with `--encrypt`, it use the native ZFS encryption:
- # getch --format zfs
+ # getch --disk vda --format zfs
With `Void Linux` and `Musl` enable:
- # getch --os void --encrypt -k fr --musl
+ # getch --disk sda --os void --encrypt -k fr --musl
## Troubleshooting
#### Old VG for LVM
If a old volume group exist, `getch` may fail to partition your disk. You have to clean up your device before proceed with `vgremove` and `pvremove`. An short example how doing this with a volume group named `vg0`:
- # vgdisplay | grep vg0
+ # vgdisplay | grep vg
# vgremove -f vg0
# pvremove -f /dev/sdb
#### Encryption with GRUB
To decrypt your disk on GRUB, only the `us` keymap is working for now.