Skip to content

Commit e7a6e10

Browse files
committed
Update README.md
1 parent cde27f3 commit e7a6e10

File tree

1 file changed

+54
-2
lines changed

1 file changed

+54
-2
lines changed

README.md

Lines changed: 54 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,59 @@
33
## Usage
44

55
First execute the binary with the `newconfig` arg, like this to create a empty config file
6-
```./[binary] [arg]
76
```
8-
After the configuration of the file execute `install` arg to init the installation
7+
./[binary] [arg] [options]
8+
```
9+
After the configuration of the file execute `--install` arg to init the installation
10+
11+
You can see more info using `[binary] --help`
12+
13+
The help message:
14+
```
15+
Usage:
16+
#[bin] [argument] -[option]
17+
-grub
18+
Only installs Grub
19+
-help
20+
Print the help message
21+
-install
22+
Run all the nesesary functions to install completely Arch Linux
23+
-mount
24+
Only mounts the disks in her routes
25+
-newconfig
26+
Creates a new config overwriting the original
27+
-noformat
28+
Don't format the partitions
29+
-nofstab
30+
Don't generate a fstab for the new system
31+
-nogrub
32+
Don't install Grub
33+
-nokeymap
34+
Don't config the keymap for the new system
35+
-nomount
36+
Don't mount the partitions
37+
-nopacmanconf
38+
Don't copy the temporal pacman.conf for best performance in the pacstrap
39+
-nopacstrap
40+
Skip the pacstrap process
41+
-nopart
42+
Skip the partitionating prosess (not open cfdisk)
43+
-nopasswd
44+
Skip the passwd setting
45+
-noreboot
46+
Don't reboot the system after the prosess
47+
-nowifi
48+
Don't configure for wifi
49+
-pacstrap
50+
Only runs the pacstrap functions
51+
-part
52+
Only changes the password of the new root
53+
-passwd
54+
Only changes the password of the new root
55+
-version
56+
Show the version of the binary
57+
58+
```
959

1060
### Configuration
1161

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

3989
#### Extra Configs
4090

91+
`passwd`: Set the root password to be used for the new installation
92+
4193
`grub_install_disk`: The storage device where the GRUB bootloader will be installed. The default value is "".
4294

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

0 commit comments

Comments
 (0)