about summary refs log tree commit diff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md61
1 files changed, 35 insertions, 26 deletions
diff --git a/README.md b/README.md
index aa22405..1215323 100644
--- a/README.md
+++ b/README.md
@@ -1,42 +1,51 @@
-## The Void Linux image/live/rootfs maker and installer
+     _                    __ 
+    | |_  _ _ _ __  _ __ / _|
+    | ' \| '_| '  \| '_ \  _|
+    |_||_|_| |_|_|_| .__/_|
+                   |_|       
 
-This repository contains utilities for Void Linux:
-
- * installer (The Void Linux el-cheapo installer for x86)
- * mklive    (The Void Linux live image maker for x86)
-
- * mkimage   (The Void Linux image maker for ARM platforms)
- * mkrootfs  (The Void Linux rootfs maker for ARM platforms)
+Welcome to the hrmpf rescue system, built on Void Linux.
+This project is based on void-mklive.
 
 #### Dependencies
 
- * xbps>=0.45
- * qemu-user-static binaries (for mkrootfs)
+* xbps>=0.45
+* GNU bash
 
-#### Usage
+#### Features
 
-Type
+* Loads of console standard tools, with a focus on:
+   * system rescue
+   * maintainance
+   * diagnosis
+   * networking
+   * security
+   * ad-hoc setups
+   * tiny bits of entertainment if you have to wait for something
 
-    $ make
+* Missing software easily installable via XBPS.
 
-and then see the usage output:
+* Non-Linux extra images (only via ISOLINUX):
+   * memtest86+
+   * iPXE
+   * FreeDOS
+   * MHDD32 hard disk analysis
+   * Bare GRUB 2
 
-    $ ./mklive.sh -h
-    $ ./mkrootfs.sh -h
-    $ ./mkimage.sh -h
+* ISO image can be burned on CD or written raw on USB stick.
 
-#### Examples
+* Load to RAM option, also bootable as MEMDISK.
 
-Build a native live image with runit and keyboard set to 'fr':
+* A plain Bash as default shell without annoying fancy configuration.
 
-    # ./mklive.sh -k fr
-
-Build an i686 (on x86\_64) live image with some additional packages:
+#### Usage
 
-    # ./mklive.sh -a i686 -p 'vim rtorrent'
+To build your own:
 
-Build an x86\_64 musl live image with packages stored in a local repository:
+    % make
+    % ./mkhrmpf.sh
+    % linux32 ./mkhrmpf.sh
 
-    # ./mklive.sh -a x86_64-musl -r /path/to/host/binpkgs
+Download pre-built images at
+<https://github.com/chneukirchen/hrmpf/releases>.
 
-See the usage output for more information :-)