aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDaniel Edgecumbe <git@esotericnonsense.com>2019-11-11 04:44:40 +0000
committerDaniel Edgecumbe <git@esotericnonsense.com>2019-11-11 04:44:40 +0000
commit05674fd363548fb85b32c147cbe1f35b8971c91c (patch)
treeeccc79d13f1afff8700ad38453f3abe8bdb8f302
parentbcb301d11b863db6d6abddf56cfed1f95714cb4b (diff)
Update README.md
-rw-r--r--README.md23
1 files changed, 16 insertions, 7 deletions
diff --git a/README.md b/README.md
index d710d2a..ea60046 100644
--- a/README.md
+++ b/README.md
@@ -1,15 +1,23 @@
----
-title: autoarch README.md
----
# autoarch
-This is a basic script, utilizing and building upon
+`autoarch` provides basic scripts to perform an automated install of
+[Arch Linux](https://archlinux.org) in a virtual machine.
-[archlinux/archiso.git](https://git.archlinux.org/archiso.git)
+Main git repository: <https://git.esotericnonsense.com/pub/autoarch.git>
-to perform an automated install of archlinux in a virtual machine.
+Sourcehut: <https://git.sr.ht/~esotericnonsense/autoarch>
-# Usage
+GitLab: <https://gitlab.com/esotericnonsense/autoarch.git>
+
+GitHub: <https://github.com/esotericnonsense/autoarch.git>
+
+## Contact
+
+Daniel Edgecumbe (esotericnonsense)
+
+[autoarch@esotericnonsense.com](mailto:autoarch@esotericnonsense.com)
+
+## Usage
To build the ISO, enter the `build` directory and run `sudo ./build.sh`.
Root permissions are required in order for the correct permissions to be
@@ -32,5 +40,6 @@ at (e.g. `vda` by default) without confirmation prior to installation.
Consider yourself warned.
## License
+
`autoarch` is subject to the GNU GPLv2 only, contained in the document
LICENSE.GPLv2 which should be distributed with the software.