Add READMEHEADmaster

1 files changed, 31 insertions, 0 deletions

diff --git a/README b/README
new file mode 100644
index 0000000..aa292b8
--- /dev/null
+++ b/README
@@ -0,0 +1,31 @@
+This is the Igloo hwpack creation tool
+
+It is basically a Makefile to automate hwpack and image creation. Included
+is also the "official" Igloo Community manifest.
+
+Usage
+======
+
+The simplest form of use is to run
+
+ $ make
+
+This will create a hwpack based on igloo.manifest and an image using the 
+hwpack and the default rootfs. The Makefile will error out if either the 
+required tools or the rootfs is not present.
+
+You can find configuration options in the toplevel Makefile. Don't 
+change those by editing though, it'll only cause trouble for updating 
+(unless you commit your changes in a branch etc).
+
+Instead you can override them from the command line, for example:
+
+ $ make VERSION=small MANIFEST=mini.manifest ROOTFS=nano.tar.gz IMAGE_SIZE=1G
+  
+to create a hypotethical tiny image based on a custom manifest.
+
+You can also build just the hwpack by running
+
+ $ make hwpack
+
+in case you don't need the image.