From 03e54da070d7ac657452e20eda59d85a48efcf63 Mon Sep 17 00:00:00 2001
From: Christian Hesse <mail@eworm.de>
Date: Wed, 26 Mar 2014 23:50:27 +0100
Subject: add some basic documentation

---
 Makefile  | 16 ++++++++++++++--
 README.md | 47 ++++++++++++++++++++++++++++++++++++++++++++++-
 bin/ykfde |  2 --
 3 files changed, 60 insertions(+), 5 deletions(-)

diff --git a/Makefile b/Makefile
index 5e0e67d..9909717 100644
--- a/Makefile
+++ b/Makefile
@@ -1,16 +1,28 @@
 # commands
 INSTALL := install
+MD	:= markdown
+RM	:= rm
 
-all: udev/ykfde
+all: udev/ykfde README.html
 
 udev/ykfde: udev/ykfde.c
 	$(MAKE) -C udev
 
-install: udev/ykfde
+README.html: README.md
+	$(MD) README.md > README.html
+
+install: install-bin install-doc
+
+install-bin: udev/ykfde
 	$(MAKE) -C udev install
 	$(INSTALL) -D -m0644 conf/ykfde.conf $(DESTDIR)/etc/ykfde.conf
 	$(INSTALL) -D -m0755 bin/ykfde $(DESTDIR)/usr/bin/ykfde
 	$(INSTALL) -D -m0644 install/ykfde $(DESTDIR)/usr/lib/initcpio/install/ykfde
 
+install-doc: README.md README.html
+	$(INSTALL) -D -m0644 README.md $(DESTDIR)/usr/share/doc/ykfde/README.md
+	$(INSTALL) -D -m0644 README.html $(DESTDIR)/usr/share/doc/ykfde/README.html
+
 clean:
 	$(MAKE) -C udev clean
+	$(RM) -f README.html
diff --git a/README.md b/README.md
index d8f595f..d688afc 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,49 @@
 mkinitcpio-ykfde
 ================
 
-Full disk encryption with Yubikey (Yubico key)
+**Full disk encryption with Yubikey (Yubico key)**
+
+This allows to automatically unlock a LUKS encrypted hard disk from `systemd`-
+enabled initramdfs.
+
+Requirements
+------------
+
+To compile and use yubico full disk encryption you need:
+
+* [iniparser](http://ndevilla.free.fr/iniparser/)
+* [systemd](http://www.freedesktop.org/wiki/Software/systemd/)
+* [mkinitcpio](https://projects.archlinux.org/mkinitcpio.git/) (Though
+  it may be easy to port this to any initramfs that uses systemd)
+* [markdown](http://daringfireball.net/projects/markdown/) (HTML documentation)
+
+Additionally it is expected to have `make` and `pkg-config` around to
+successfully compile.
+
+Build and install
+-----------------
+
+Building and installing is very easy. Just run:
+
+> make
+
+followed by:
+
+> make install
+
+This will place file to their desired places in filesystem.
+
+Usage
+-----
+
+First prepare the key. Plug it in, make sure it is configured for HMAC-
+SHA1, then run:
+
+> ykfde -d /dev/`LUKS-device`
+
+This will add a new slot to your LUKS device. Add `ykfde` to your hook
+list in `/etc/mkinitcpio.conf` and rebuild your initramfs with:
+
+> mkinitcpio -p linux
+
+Reboot and have fun!
diff --git a/bin/ykfde b/bin/ykfde
index 5f85387..3901f2e 100644
--- a/bin/ykfde
+++ b/bin/ykfde
@@ -1,7 +1,5 @@
 #!/bin/sh
 
-source /etc/ykfde.conf
-
 function help() {
 	echo "usage: ${0} [OPTIONS]"
 	echo
-- 
cgit v1.2.3-70-g09d2