docs: add Raspberry Pi ref to docs/index.md

[contrib/mraa.git] / docs / index.md

diff --git a/docs/index.md b/docs/index.md
index bcc19c6..6deda79 100644 (file)
--- a/docs/index.md
+++ b/docs/index.md
@@ -1,11 +1,14 @@
-MRAA - Low Level Skeleton Library for Communication on Intel platforms
+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 nanmes/numbering that match boards & with
-bindings to javascript & python.
+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
+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.
 
@@ -16,14 +19,15 @@ classes directly wrap the C API and provide a near 1:1 mapping of
 functionality.
 
 <center>
-| C API Modules          | C++ API Classes             |
-|:----------------------:|:---------------------------:|
+| C API Modules          | C++ API Classes              |
+|:----------------------:|:----------------------------:|
 | @ref gpio.h "gpio"     | @ref mraa::Gpio "Gpio class" |
 | @ref i2c.h "i2c"       | @ref mraa::I2c "I2c class"   |
 | @ref aio.h "aio"       | @ref mraa::Aio "Aio class"   |
 | @ref pwm.h "pwm"       | @ref mraa::Pwm "Pwm class"   |
 | @ref spi.h "spi"       | @ref mraa::Spi "Spi class"   |
-| @ref common.h "common" | @ref common.hpp "common"     |
+| @ref uart.h "uart"     | @ref mraa::Uart "Uart class" |
+| @ref common.h "common" | @ref mraa "common"           |
 </center>
 
 ### Hello Mraa
@@ -35,24 +39,29 @@ Specific platform information for supported platforms is documented here:
 
 - @ref galileorevd
 - @ref galileorevh
+- @ref edison
+- @ref de3815
+- @ref minnowmax
+- @ref rasppib
 
 ### ENV RECOMENDATIONS
 
 All of these are 'optional', however they are recommended. Only a C compiler,
 cmake, libm and pthreads are technically required to compile.
 
-- Swig 3.0.1+ built with node.js & python support (0.10.x)
+- Swig 3.0.1+ built with node.js (0.10.x) & python support
 - doxygen
 - sphinx (requires doxygen)
 - pygments
 
 ## COMPILING
 
-More information on compiling is @ref building page
+More information on compiling is @ref building page.
 
 ## CONTRIBUTING
 
-Please see the @ref contributing page
+Please see the @ref contributing page, the @ref internals page may also be of
+use.
 
 ## API Changelog
 
@@ -60,6 +69,56 @@ This changelog is meant as a quick & rough guide to what has changed between
 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.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
+  * Additional platform hooks added
+  * ADC is now 10bits by default on all platforms but can be changed
+
+**0.4.5**
+  * if only one spidev we default to it reguardless of number
+  * mraa_pwm_config_ms & mraa_pwm_config_percent functions added
+  * Uart C++ class added, adds python & node support
+  * galileo gen2 gpio modes supported
+
+**0.4.4**
+  * prefix SPI mode with MRAA_SPI_
+  * added C++ adc bitness calls
+
 **0.4.3**
   * SPI Mode function now functional, API Change in SPI
   * I2C read in swig worked on.