From dcb5b83e161c6d368bb53293fa3b06d673b5c62c Mon Sep 17 00:00:00 2001
From: Bart Van Der Meerssche <bart.vandermeerssche@flukso.net>
Date: Thu, 16 Jun 2011 00:05:57 +0200
Subject: [PATCH] [readme] update readme to reflect the reduced scope of the
 repo

---
 README | 68 +++++++++++++++++++++++++++++++++++-----------------------
 1 file changed, 41 insertions(+), 27 deletions(-)

diff --git a/README b/README
index 205cd56..de6ff72 100644
--- a/README
+++ b/README
@@ -1,31 +1,45 @@
-Welcome to the Flukso repository.
+This git repo contains the code needed for builing an OpenWRT Kamikaze-based
+firmware for the Fluksometer v1, aka FLM01.
 
-The repository is structured as follows:
-* mote/v[1|2]/openwrt
-The modules, patches and scripts needed to tailor a stock OpenWRT Backfire to
-the Fluksometer hardware. The bulk of development will now be taking place in
-the v2 directory which maps to the v2 hardware.
-* mote/v[1|2]/eagle
-The Eagle schematic, board and BOM files for building a v1 or v2 Flukso sensor
-board.
-* mote/v[1|2]/avr
-The AVR microcontroller code for the Flukso sensor board.
-* server/api
-The Erlang/Webmachine code that handles the Flukso server's JSON/REST API.
-* server/drupal
-Custom Drupal v6 modules that transform a Drupal 6 installation into a community
-metering web platform, see a.o. www.flukso.net or www.mysmartgrid.de.
+tree:
+.
+|-- avr
+|   `-- wiring
+|-- eagle
+|   `-- prj
+|       |-- flukso.sensor.board.v1
+|       |-- flukso.sensor.board.v1.1
+|       `-- flukso.sensor.board.v1.2
+`-- openwrt
+    |-- files
+    |   `-- etc
+    |-- package
+    |   |-- avahi
+    |   |-- button
+    |   |-- expat
+    |   |-- flukso
+    |   |-- gdbm
+    |   |-- intltool
+    |   |-- libdaemon
+    |   |-- luaexpat
+    |   |-- luasocket
+    |   |-- luaxmlrpc
+    |   |-- luaxyssl
+    |   |-- luci
+    |   |-- ntpclient
+    |   `-- xyssl
+    `-- patches
+
+avr: AVR microcontroller code for the v2 Flukso sensor board
+
+eagle: Eagle schematic, board and BOM files for building a v2 Flukso sensor
+board
+
+openwrt: the modules, patches and scripts needed to tailor a stock OpenWRT
+Backfire to the Fluksometer hardware.
 
 
-For more information about this project and to see the code in action, surf to
-www.flukso.net.
+$forum = www.flukso.net/forum
+$mailing_list = flukso-dev-join@lists.flukso.net
+$irc = #flukso on freenode
 
-Interested in contributing code- or schematic-wise? Then please join the
-flukso-dev mailing list.
-You can sign up via the web: http://lists.flukso.net/mailman/listinfo/flukso-dev.
-Or simply drop a mail to this address: flukso-dev-join@lists.flukso.net.
-
-You can also harass us via IRC in the #flukso channel on freenode.
-
-Happy metering!
-Bart.