From 9fbc35fb91a34adc4b167ded513c8f908d4399f0 Mon Sep 17 00:00:00 2001 From: TuDatTr Date: Sat, 23 May 2020 18:39:48 +0200 Subject: [PATCH] Added a "how to use" section to the README.md --- README.md | 16 ++++++++++++++++ install.sh | 6 +++--- 2 files changed, 19 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 55c096d..9c84892 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,19 @@ # March 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 +``` diff --git a/install.sh b/install.sh index dba24ca..c184455 100755 --- a/install.sh +++ b/install.sh @@ -52,10 +52,10 @@ while true; do shift 2 ;; -h|--help) - description=$(< tail -n +3 $CWD/README.md) echo " 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: -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" @@ -63,7 +63,7 @@ Mandatory arguments: -h | --hostname Name for your machine e.g. "ArchLinux" -u | --username Your username e.g. "foo" -s | --sudogrp Name of the sudogrp --h | --help This ehre. +-h | --help This here. " exit 0 ;;