Clarified README and added screenshot

This commit is contained in:
oddlama 2021-05-31 21:06:46 +02:00
parent b1113daf6f
commit 0b3755d7c5
No known key found for this signature in database
GPG Key ID: 14EFE510775FE39A
3 changed files with 11 additions and 6 deletions

View File

@ -1,8 +1,14 @@
## About gentoo-install
A installer for gentoo with a simple menuconfig inspired configuration TUI.
This is an installer for gentoo with a simple configuration TUI inspired by menuconfig.
The configurator is only used to generate a `gentoo.conf` file, which can also be
edited by hand if desired. An example configuration is provided with the repository.
edited by hand, or reused later if desired. An example configuration is provided with the repository.
The installer supports the most common disk layouts, different file systems like ext4, ZFS and btrfs as well
as additional layers such as LUKS or mdraid. It also supports both EFI (recommended) and BIOS boot,
and can be used with systemd or OpenRC as the init system.
![](contrib/screenshot_configure.png)
## Quick start
@ -19,10 +25,6 @@ When installing, you will be asked to review the partitioning before anything cr
## Overview
This script performs a reasonably minimal installation of gentoo. An EFI system is highly
recommended, but legacy BIOS boot is also supported. The script supports both systemd (default)
and OpenRC as the init system.
The system will use `sys-kernel/gentoo-kernel-bin`, which should be suitable
to boot most systems out of the box. It is strongly recommend to replace this kernel
with a custom built one, when the system is functional.
@ -31,6 +33,8 @@ The installer should be able to run without any user supervision after partition
on the current state of the gentoo repository you might need to intervene in case a package fails
to emerge. The critical commands will ask you what to do in case of a failure.
Here is an outline of the steps that are carried out:
1. Partition disks (supports gpt, raid, luks)
1. Download and cryptographically verify the newest stage3 tarball
1. Extract the stage3 tarball

Binary file not shown.

Before

Width:  |  Height:  |  Size: 34 KiB

After

Width:  |  Height:  |  Size: 35 KiB

View File

@ -16,6 +16,7 @@
# Be sure to only define one layout!
# This function will be called when a custom zfs pool type has been chosen.
# You do not need to change this, unless you have chosen a custom zfs pool type.
# $1: either 'true' or 'false' determining if the pool should be encrypted
# $2: a string describing all device paths (for error messages)
# $@: device paths