add requirements

[julm/air-duino.git] / README

diff --git a/README b/README
index 46542ca8e4da51235a9f258cc86aae4685f95410..d45831ec2e0b738d918d3db9ad01df9f2cc884b1 100644 (file)
--- a/README
+++ b/README
@@ -1,11 +1,48 @@
-# Building in build-uno/
-make ino
+Requirements
+============
+- arduino-mk
+- make (GNU)
+- perl
+- rrdtool
+- xsltproc
 
-# Uploading on /dev/ttyUSB0 (to be adapted)
-make DEVICE_PATH=/dev/ttyUSB0 upload
+- libraries/AirQuality_Sensor/
+- libraries/DustSensor/
+- libraries/Humidity_Temperature_Sensor/
+- libraries/LCD_Display9696/
 
-# Collecting in rrd/ from /dev/ttyUSB0 (to be adapted)
-./collect.pl /dev/ttyUSB0 &
+Build in build-uno/
+-------------------
+$ make ino
 
-# Rendering in png/
-make png
+Upload on /dev/ttyUSB0 (to be adapted)
+--------------------------------------
+$ make DEVICE_PATH=/dev/ttyUSB0 upload
+
+Collect in rrd/ from /dev/ttyUSB0 (to be adapted)
+-------------------------------------------------
+$ ./collect.pl /dev/ttyUSB0 &
+
+Generate .png in view/
+---------------------
+$ make view/png
+
+Generate .png in view/ for specific dates
+----------------------------------------
+$ make view/png years=2015 months=11 days="01 02"
+
+or by using full file paths:
+
+$ make view/{humidity,particles,quality,temperature}/2015/11/01.png
+
+Generate .html5 in view/
+-----------------------
+$ make view/html5
+
+Generate .html5 in view/ for specific dates
+------------------------------------------
+$ make view/html5 years=2015 months=11 days="01 02"
+
+or by using full file paths:
+
+$ make view/2015/11.html5