From 1ea621989c5d7663fbc0c299e0c67afac0a549fb Mon Sep 17 00:00:00 2001
From: Piotr Dobrowolski <admin@tastycode.pl>
Date: Thu, 28 Jan 2016 22:21:40 +0100
Subject: [PATCH] Add README.md

---
 README.md   | 27 +++++++++++++++++++++++++++
 data/config |  1 +
 2 files changed, 28 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..aeb4062
--- /dev/null
+++ b/README.md
@@ -0,0 +1,27 @@
+zsun-fw-tools
+=============
+
+[Read more here.](https://wiki.hackerspace.pl/projects:zsun-wifi-card-reader:factory-update)
+
+Building
+--------
+
+*NOTE:* Builder depends on `md5sum` and `tar`
+
+1. Copy your `openwrt-ar71xx-generic-zsun-sdreader-kernel.bin` and
+   `openwrt-ar71xx-generic-zsun-sdreader-rootfs-squash.bin` to `data/` folder
+2. Run `./makefirmware`
+
+Flashing
+--------
+
+*NOTE:* Flasher depends on `smbclient` and `curl`
+
+*NOTE:* Update package is rebuilt on every flash, if you don't like this
+behaviour, comment out `. ./makefirmware` file and change `UPDATEFILE` variable
+
+*NOTE:* This is not really idiotproof
+
+1. Run `./flashfirmware`
+2. ...
+3. PROFIT!
diff --git a/data/config b/data/config
index 34d999d..eb54057 100644
--- a/data/config
+++ b/data/config
@@ -1,2 +1,3 @@
 openwrt-ar71xx-generic-zsun-sdreader-kernel.bin:S:/dev/mtd3
 openwrt-ar71xx-generic-zsun-sdreader-rootfs-squashfs.bin:S:/dev/mtd2
+# NOTE: this is only used for file validation, check ./mtd_write script