Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Tom5521 committed Nov 18, 2023
1 parent cde27f3 commit e7a6e10
Showing 1 changed file with 54 additions and 2 deletions.
56 changes: 54 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,59 @@
## Usage

First execute the binary with the `newconfig` arg, like this to create a empty config file
```./[binary] [arg]
```
After the configuration of the file execute `install` arg to init the installation
./[binary] [arg] [options]
```
After the configuration of the file execute `--install` arg to init the installation

You can see more info using `[binary] --help`

The help message:
```
Usage:
#[bin] [argument] -[option]
-grub
Only installs Grub
-help
Print the help message
-install
Run all the nesesary functions to install completely Arch Linux
-mount
Only mounts the disks in her routes
-newconfig
Creates a new config overwriting the original
-noformat
Don't format the partitions
-nofstab
Don't generate a fstab for the new system
-nogrub
Don't install Grub
-nokeymap
Don't config the keymap for the new system
-nomount
Don't mount the partitions
-nopacmanconf
Don't copy the temporal pacman.conf for best performance in the pacstrap
-nopacstrap
Skip the pacstrap process
-nopart
Skip the partitionating prosess (not open cfdisk)
-nopasswd
Skip the passwd setting
-noreboot
Don't reboot the system after the prosess
-nowifi
Don't configure for wifi
-pacstrap
Only runs the pacstrap functions
-part
Only changes the password of the new root
-passwd
Only changes the password of the new root
-version
Show the version of the binary
```

### Configuration

Expand Down Expand Up @@ -38,6 +88,8 @@ The YAML file is a data structure used to configure the installation parameters

#### Extra Configs

`passwd`: Set the root password to be used for the new installation

`grub_install_disk`: The storage device where the GRUB bootloader will be installed. The default value is "".

`pacstrap_skip`: A boolean value indicating whether to skip the installation of Arch Linux basic packages. The default value is "false".
Expand Down

0 comments on commit e7a6e10

Please sign in to comment.