Added a "how to use" section to the README.md

This commit is contained in:
TuDatTr
2020-05-23 18:39:48 +02:00
parent d87aa3dce5
commit 9fbc35fb91
2 changed files with 19 additions and 3 deletions

View File

@@ -1,3 +1,19 @@
# March # March
A small script to automate my archlinux configuration. A small script to automate my archlinux configuration.
## How to use it
First off we need to install git to download this repo.
```sh
pacman -Sy
pacman -S git
```
Then we can download this repo and run the install script.
```sh
git clone https://gitlab.com/TuDatTr/march
chmod ./march/install.sh
./install.sh
```

View File

@@ -52,10 +52,10 @@ while true; do
shift 2 shift 2
;; ;;
-h|--help) -h|--help)
description=$(< tail -n +3 $CWD/README.md)
echo " echo "
Usage: ./install.sh -d [DEVICE] -t [/usr/share/zoneinfo/REGION/CITY] -l [LOCALE] -h [HOSTNAME] -u [USER] -s [SUDO] Usage: ./install.sh -d [DEVICE] -t [/usr/share/zoneinfo/REGION/CITY] -l [LOCALE] -h [HOSTNAME] -u [USER] -s [SUDO]
A small script to automate my archlinux configuration.
$
Mandatory arguments: Mandatory arguments:
-d | --device Device that shoud be partitioned e.g. "/dev/sda" -d | --device Device that shoud be partitioned e.g. "/dev/sda"
-t | --timezone Your timezone according to /usr/share/zoneinfo/ e.g. "/usr/share/zoneinfo/EUROPE/Berlin" -t | --timezone Your timezone according to /usr/share/zoneinfo/ e.g. "/usr/share/zoneinfo/EUROPE/Berlin"
@@ -63,7 +63,7 @@ Mandatory arguments:
-h | --hostname Name for your machine e.g. "ArchLinux" -h | --hostname Name for your machine e.g. "ArchLinux"
-u | --username Your username e.g. "foo" -u | --username Your username e.g. "foo"
-s | --sudogrp Name of the sudogrp -s | --sudogrp Name of the sudogrp
-h | --help This ehre. -h | --help This here.
" "
exit 0 exit 0
;; ;;