merging FLUKSO-2-0-beta-1

README

@@ -1,45 +1,31 @@
-This git repo contains the code needed for builing an OpenWRT Kamikaze-based
+Welcome to the Flukso repository.
-firmware for the Fluksometer v1, aka FLM01.
 
-tree:
+The repository is structured as follows:
-.
+* mote/v[1|2]/openwrt
-|-- avr
+The modules, patches and scripts needed to tailor a stock OpenWRT Backfire to
-|   `-- wiring
+the Fluksometer hardware. The bulk of development will now be taking place in
-|-- eagle
+the v2 directory which maps to the v2 hardware.
-|   `-- prj
+* mote/v[1|2]/eagle
-|       |-- flukso.sensor.board.v1
+The Eagle schematic, board and BOM files for building a v1 or v2 Flukso sensor
-|       |-- flukso.sensor.board.v1.1
+board.
-|       `-- flukso.sensor.board.v1.2
+* mote/v[1|2]/avr
-`-- openwrt
+The AVR microcontroller code for the Flukso sensor board.
-    |-- files
+* server/api
-    |   `-- etc
+The Erlang/Webmachine code that handles the Flukso server's JSON/REST API.
-    |-- package
+* server/drupal
-    |   |-- avahi
+Custom Drupal v6 modules that transform a Drupal 6 installation into a community
-    |   |-- button
+metering web platform, see a.o. www.flukso.net or www.mysmartgrid.de.
-    |   |-- 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.
 
 
-$forum = www.flukso.net/forum
+For more information about this project and to see the code in action, surf to
-$mailing_list = flukso-dev-join@lists.flukso.net
+www.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.