aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDaniel Edgecumbe <git@esotericnonsense.com>2019-11-11 04:41:19 +0000
committerDaniel Edgecumbe <git@esotericnonsense.com>2019-11-11 04:41:19 +0000
commitbcb301d11b863db6d6abddf56cfed1f95714cb4b (patch)
tree39d6cba893e7281258f6657fc155d2829987ac6b
parent4741495c6c3ae40cb68489875484c02101195978 (diff)
Update README.md
-rw-r--r--README.md15
1 files changed, 15 insertions, 0 deletions
diff --git a/README.md b/README.md
index 7e77f03..d710d2a 100644
--- a/README.md
+++ b/README.md
@@ -9,6 +9,21 @@ This is a basic script, utilizing and building upon
to perform an automated install of archlinux in a virtual machine.
+# 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
+set within the built image.
+
+The built ISO will by default be placed in `/tmp/archiso-out`.
+
+By default, this ISO will use the install script present in the repo it is
+built from. By modifying `build/config.sh` prior to building, a remote
+repository can be specified which will be cloned at runtime.
+
+More options are available in `install/config.sh` for configuration of the
+installed system.
+
## Important note
The created ISO will _completely erase_ the contents of the disk you point it