doc: update the README to reflect the current repository layout
This commit is contained in:
parent
76b5ef7a3d
commit
1833e0c1c8
35
README
35
README
|
@ -1,8 +1,31 @@
|
||||||
This repository holds the code for the community metering project called Flukso and is split into following subsections:
|
Welcome to the Flukso repository.
|
||||||
- web/drupal: theme and modules that turn a stock Drupal installation into www.flukso.net
|
|
||||||
- web/api: our Erlang/Webmachine-based JSON/REST code for api.flukso.net
|
|
||||||
- openwrt: contains openwrt packages/patches/make menuconfig to tweak a stock openwrt kamikaze build into a Fluksometer
|
|
||||||
- uc: the microcontroller code that is loaded onto the sensor board's AVR.
|
|
||||||
|
|
||||||
Enjoy!
|
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.
|
||||||
|
|
||||||
|
|
||||||
|
For more information about this project and to see the code in action, surf to
|
||||||
|
www.flukso.net.
|
||||||
|
|
||||||
|
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.
|
Bart.
|
||||||
|
|
Loading…
Reference in New Issue