From: Pete Batard <pete@akeo.ie>
Date: Sat, 7 Nov 2015 17:50:40 +0000 (+0000)
Subject: Update README
X-Git-Url: https://git.halfball.org/?a=commitdiff_plain;h=f1944822baddff169dc143a1ba80dd5d90b081c7;p=parrot.git

Update README
---

diff --git a/README.md b/README.md
index 66deca5..a8ebcb4 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,36 @@
-# Parrot - A Linux device driver sample
+Parrot Linux device driver sample
+=================================
 
-See http://pete.akeo.ie/2011/08/writing-linux-device-driver-for-kernels.html
+This is a GPLv2+ sample implementation of a Linux 3.x or 2.x character
+device driver based on [udev](https://en.wikipedia.org/wiki/Udev).
+
+From more background information as well as a detailed walkthrough, 
+see the following [blog post](http://pete.akeo.ie/2011/08/writing-linux-device-driver-for-kernels.html).
+
+* __Requirements__:
+  * gcc
+  * A recent Linux kernel (with its source)
+
+* __Compilation__:
+  * Just invoke `make` as root
+
+* __Testing__:
+  * `insmod parrot_driver.ko debug=1`
+  * `lsmod | grep parrot`
+  * `echo "Yabba Dabba Doo" > /sys/devices/virtual/parrot/parrot_device/fifo`
+  * `cat /dev/parrot_device`
+
+* __Notes__:
+On a Debian system, and if you haven't recompiled a kernel before, you may
+have to issue the following before you can compile and run the driver:
+```
+cd /usr/src
+apt-get install linux-headers
+uname -r	# Get the version of your kernel, e.g. '3.16.0-4-amd64'
+apt-get install linux-source-3.16	# Use the same major.minor as above
+tar -xJvf linux-source-3.16.tar.xz
+ln -s linux-source-3.16 linux
+cd /usr/src/linux
+cp /usr/src/linux-headers-$(uname -r)/Module.symvers .
+make oldconfig && make prepare && make scripts
+```