summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md18
1 files changed, 15 insertions, 3 deletions
diff --git a/README.md b/README.md
index 2ad1a29..8fcaf1a 100644
--- a/README.md
+++ b/README.md
@@ -4,15 +4,17 @@ Amenthes is an environment for creating a live Linux system which allows secure
The project is based on the wonderful [archiso](https://wiki.archlinux.org/index.php/Archiso) scripts.
-## Build
+## Prerequisites
+
+An existing `x86_64` [Arch Linux](https://www.archlinux.org/) system with `archiso` or `archiso-git` installed.
-Naturally, requires Arch. First, make sure you have `archiso` or `archiso-git` installed.
+## Build
```bash
$ sudo su # become root now, otherwise you get ugly permissions problems
$ chown -R root:root liveusb
$ cd liveusb
-$ ./build.sh -v
+$ ./build.sh
```
You should now see `out/amenthes-x86_64.iso`, which can be directly copied to a USB drive:
@@ -21,6 +23,16 @@ You should now see `out/amenthes-x86_64.iso`, which can be directly copied to a
$ dd bs=4M if=out/amenthes-x86_64.iso of=/dev/sdX && sync
```
+### Testing
+
+For test builds targeting a VirtualBox VM, use the `-t` flag to add some required packages:
+
+```bash
+$ ./build.sh -t
+```
+
+Never target a VM for the real-life scenario, a VM client cannot be secured against a malicious VM host. Using this flag lets the end-user run under a VM, so just don't.
+
## Design
First and foremost, Amenthes is a **proof of concept** project, and should never be used *as is*, assuming it will save your ass when shit hits the fan. Amenthes is a demonstration of technology which might be adopted to real-life use by experienced system administrators or developers. Having said that...