mraa: rename from maa to mraa

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

diff --git a/docs/index.md b/docs/index.md
index 991ee9f..964ff6d 100644 (file)
--- a/docs/index.md
+++ b/docs/index.md
@@ -1,4 +1,4 @@
-MAA - Low Level Skeleton Library for Communication on Intel platforms
+MRAA - Low Level Skeleton Library for Communication on Intel platforms
 ==============
 
 Library in C/C++ to interface with Galileo & other Intel platforms, in a
@@ -11,23 +11,23 @@ low level communication protocol by high level languages & constructs.
 
 ## API
 
-These interfaces allow you to interact with all libmaa functionality. The C++
+These interfaces allow you to interact with all libmraa functionality. The C++
 classes directly wrap the C API and provide a near 1:1 mapping of
 functionality.
 
 <center>
 | C API Modules          | C++ API Classes             |
 |:----------------------:|:---------------------------:|
-| @ref gpio.h "gpio"     | @ref maa::Gpio "Gpio class" |
-| @ref i2c.h "i2c"       | @ref maa::I2c "I2c class"   |
-| @ref aio.h "aio"       | @ref maa::Aio "Aio class"   |
-| @ref pwm.h "pwm"       | @ref maa::Pwm "Pwm class"   |
-| @ref spi.h "spi"       | @ref maa::Spi "Spi class"   |
+| @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.h "common"      |
 </center>
 
-### Hello Maa
-@snippet hellomaa.c Interesting
+### Hello Mraa
+@snippet hellomraa.c Interesting
 
 ## Supported platforms
 
@@ -61,20 +61,20 @@ they are listed here. Anything pre 0.2.x is ignored.
 
 **0.3.1**
   * Initial Intel Galileo Gen 2 support
-  * maa_gpio_isr parameters added.
+  * mraa_gpio_isr parameters added.
   * Detection of different supported platforms added.
 
 **0.3.0**
-  * maa_i2c_read now returns length of read
+  * mraa_i2c_read now returns length of read
 
 **0.2.9**
-  * Add global maa.h & maa.hpp headers
-  * usage of "gpio.h" is not legal you need to use "maa/gpio.h" unless adding
-    -L/usr/include/maa
+  * Add global mraa.h & mraa.hpp headers
+  * usage of "gpio.h" is not legal you need to use "mraa/gpio.h" unless adding
+    -L/usr/include/mraa
 
 **0.2.8**
-  * Added maa_set_priority call
-  * Added mmap gpio call maa_gpio_use_mmaped
+  * Added mraa_set_priority call
+  * Added mmap gpio call mraa_gpio_use_mmaped
 
 **0.2.7**
   * C++ API now uses basic types and not unistd types as C
@@ -83,7 +83,7 @@ they are listed here. Anything pre 0.2.x is ignored.
 **0.2.6**
   * C++ examples added, using c++ headers/api.
   * moved to open instead of fopen in all modules
-  * rename maa_check functions and made them internal to maa only.
+  * rename mraa_check functions and made them internal to mraa only.
   * removed "export" functions from api
   * Intel Galileo Gen 1 (rev d) fixes, incorrect definition of some items
   * SPI, implementation completed.
@@ -94,23 +94,23 @@ they are listed here. Anything pre 0.2.x is ignored.
   * GPIO/PWM ownership guard prevents closing on existing pins, still can be forced.
 
 **0.2.5**
-  * C++/Python/Node Enums/const names now do not contain MAA_GPIO
+  * C++/Python/Node Enums/const names now do not contain MRAA_GPIO
   * Enum type declaration for C++ changed
   * Python/Node get_version() -> GetVersion()
   * i2c read calls don't use const char* and i2c write calls do
 
 **0.2.4**
-  * All maa_ contexts now are pointers to the actual struct which is not
+  * All mraa_ contexts now are pointers to the actual struct which is not
     delcared in the header. The only end user change is that instead of
-    returning a type maa_gpio_context pointer maa_gpio_init() now returns a
-    maa_gpio_context (which is actually a pointer to struct _gpio internally).
+    returning a type mraa_gpio_context pointer mraa_gpio_init() now returns a
+    mraa_gpio_context (which is actually a pointer to struct _gpio internally).
   * C++ API is available, use the .hpp headers and add stdc++  to the linker
     flags.
   * Initial SPI implementation is provided
 
 **0.2.3**
-  * maa_aio_read_u16() -> maa_aio_read()
-  * maa_aio_read() now returns a uint16_t instead of an unsigned int
+  * mraa_aio_read_u16() -> mraa_aio_read()
+  * mraa_aio_read() now returns a uint16_t instead of an unsigned int
 
 **0.2.2**
   * First version with API considered 'stable'