libmraa - Low Level Skeleton Library for Communication on Intel platforms
==============
-Library in C/C++ to interface with Galileo & other Intel platforms, in a
-structured and sane API with port names/numbering that match boards & with
-bindings to javascript & python.
-
-The intent is to make it easier for developers and sensor manufacturers to map
+Libmraa is a C/C++ library with bindings to javascript & python to interface
+with the IO on Galileo, Edison & other platforms, with a structured and sane
+API where port names/numbering matches the board that you are on. Use of
+libmraa does not tie you to specific hardware with board detection done at
+runtime you can create portable code that will work across the supported
+platforms.
+
+The intent is to make it easier for developers and sensor manufacturers to map
their sensors & actuators on top of supported hardware and to allow control of
low level communication protocol by high level languages & constructs.
- @ref galileorevd
- @ref galileorevh
- @ref edison
+- @ref de3815
+- @ref minnowmax
+- @ref rasppi
-### ENV RECOMENDATIONS
-
-All of these are 'optional', however they are recommended. Only a C compiler,
-cmake, libm and pthreads are technically required to compile.
+## DEBUGGING
-- Swig 3.0.1+ built with node.js & python support (0.10.x)
-- doxygen
-- sphinx (requires doxygen)
-- pygments
+Sometimes it just doesn't want to work, let us try and help you, you can file
+issues in github or join us in #mraa on freenode IRC, hang around for a little
+while because we're not necessarily on 24/7, but we'll get back to you! Have a
+glance at our @debugging page too
## COMPILING
versions. The API is now fairly stable but when new calls/features are added
they are listed here. Anything pre 0.2.x is ignored.
+**0.6.0**
+ * add device path queries for uart
+ * add platform configuration querying
+ * gpio sample added
+ * improve i2c/spi write/read API for python & nodejs
+ * performance improvements on edison & galileo
+
+**0.5.4**
+ * pwm read_* fix introduced in 0.5.3
+ * improved npmpkg support
+
+**0.5.3**
+ * OE toolchain support added to CMake
+ * Various UART fixes
+ * SPI add CS exposure
+ * Remove functions from mraa.c into modules
+ * Rework of support for mmap
+ * Intel Edison MMAP support added. Read and Write
+ * I2C clean up, add cleaner functions
+ * MinnowBoard Max support added
+ * PWM period is written before duty
+ * Node GYP build supported added
+ * Add Get Platform Name function
+
+**0.5.2**
+ * pwm improvement & bugfix
+ * spi mraa_spi_bit_per_word fix
+ * new spi transfer function
+ * i2c object api uses uint8_t
+ * i2c readReg() calls added
+ * edison i2c bus now defaults to a sensible value
+ * edison uart enable support
+ * edison hardware CS exposed as IO10
+ * DE3815tykhe NUC support
+
+**0.5.1**
+ * Intel Edison - Mini breakout board support
+ * Change to use syslog throughout instead of printing to stderr.
+ * Fix misc issues brought up throuh coverity scans
+ * Clear up Analog call documentation
+
**0.5.0**
* Intel Edison - Arduino board support.
* Boost Allowable i2c busses to 12