From 1bd702a04023c6e9c3bba1b0c77c992bd0ab8b63 Mon Sep 17 00:00:00 2001 From: Horea Christian Date: Sun, 18 May 2014 23:59:40 +0200 Subject: [PATCH] Style improvements --- README.md | 18 ++++++++++-------- 1 file changed, 10 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 191597a..ad67729 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,16 @@ #mkstage4 -Nash script to create stage 4 tarballs either for the running system, or a system at a specified mount point. -The script is a new edition of the [mkstage4 script by Greg Fitzgerald](https://github.com/gregf/bin/blob/master/mkstage4) (unmaintained as of 2012) which is itself a revamped edition of the [original mkstage4](http://blinkeye.ch/dokuwiki/doku.php/projects/mkstage4) by Reto Glauser (unmaintaied as of 2009). -More information on this script can be found on the respective [Chymeric Tutorials article](http://tutorials.chymera.eu/blog/2014/05/18/mkstage4-stage4-tarballs-made-easy/). +This is a bash script to create stage 4 tarballs either for the running system, or a system at a specified mount point. +The script is a new edition of an earlier [mkstage4 script](https://github.com/gregf/bin/blob/master/mkstage4) by Greg Fitzgerald (unmaintained as of 2012) which is itself a revamped edition of the [original mkstage4](http://blinkeye.ch/dokuwiki/doku.php/projects/mkstage4) by Reto Glauser (unmaintaied as of 2009). + +More information on mkstage4 can be found on its own Chymeric Tutorials article: [mkstage4 - Stage 4 Tarballs Made Easy](http://tutorials.chymera.eu/blog/2014/05/18/mkstage4-stage4-tarballs-made-easy/). ##Usage -Running mksatge4 from its own directory: +Preparing to run mkstage4 from its own directory: ```bash +git clone https://github.com/TheChymera/mkstage4.git /your/mkstage4/directory cd /your/mkstage4/directory chmod +x mkstage4.sh ``` @@ -27,9 +29,9 @@ Archive system located at a custom mount point: Other options: -* ```-q``` (quiet) prompts of confirmation. -* ```-b``` (no-boot) excludes the ```/boot``` (or ```/cutom/mount/point/boot```). -* ```-c``` (no-connman) excludes connman saved networks directory. +* ```-q```: (quiet) runs without prompting for confirmation (careful!). +* ```-b```: (no-boot) excludes the ```/boot``` (or ```/cutom/mount/point/boot```) directory. +* ```-c```: (no-connman) excludes connman saved networks directory. ##Extract Tarball @@ -44,7 +46,7 @@ tar xvjpf archive_name.tar.bz2 * **[Bash](https://en.wikipedia.org/wiki/Bash_(Unix_shell))** - in [Portage](http://en.wikipedia.org/wiki/Portage_(software)) as **app-shells/bash** * **[tar](https://en.wikipedia.org/wiki/Tar_(computing))** - in Portage as **app-arch/tar** -Please note that these are very basic dependencies and should be already included in any Linux system. +Please note that these are very basic dependencies and should already be included in any Linux system. ##Meta Released under the GPLv3 license.