about summary refs log tree commit diff
path: root/README.md
diff options
context:
space:
mode:
authorJuan RP <xtraeme@gmail.com>2014-04-23 11:30:05 +0200
committerJuan RP <xtraeme@gmail.com>2014-04-23 11:30:05 +0200
commita9ea9ea750a16993066bec4fa305a5de29c3ce0b (patch)
treec480657c001e016a9fc5a0c74eadd21714c2cb7d /README.md
parent844f9e4607f62944eea371b8cb2522bc4d46ccd2 (diff)
downloadhrmpf-a9ea9ea750a16993066bec4fa305a5de29c3ce0b.tar.gz
hrmpf-a9ea9ea750a16993066bec4fa305a5de29c3ce0b.tar.xz
hrmpf-a9ea9ea750a16993066bec4fa305a5de29c3ce0b.zip
README.md: sync with reality.
Diffstat (limited to 'README.md')
-rw-r--r--README.md19
1 files changed, 15 insertions, 4 deletions
diff --git a/README.md b/README.md
index be71d5e..fa42044 100644
--- a/README.md
+++ b/README.md
@@ -2,11 +2,11 @@
 
 This repository contains utilities for Void Linux:
 
- * void-installer (The Void Linux el-cheapo installer for x86)
- * void-mklive    (The Void Linux live image maker for x86)
+ * installer (The Void Linux el-cheapo installer for x86)
+ * mklive    (The Void Linux live image maker for x86)
 
- * void-mkimage   (The Void Linux image maker for ARM platforms)
- * void-mkrootfs  (The Void Linux rootfs maker for ARM platforms)
+ * mkimage   (The Void Linux image maker for ARM platforms)
+ * mkrootfs  (The Void Linux rootfs maker for ARM platforms)
 
 #### Dependencies
 
@@ -19,3 +19,14 @@ This repository contains utilities for Void Linux:
  * parted (to generate image)
  * qemu-user-static binaries (to generate foreign rootfs)
 
+#### Usage
+
+Type
+
+    $ make
+
+and then see the usage output:
+
+    $ ./mklive.sh -h
+    $ ./mkrootfs.sh -h
+    $ ./mkimage.sh -h