maa: hide and rename internal maa functions

[contrib/mraa.git] / README.md

diff --git a/README.md b/README.md
index d63fc60..334e8f5 100644 (file)
--- a/README.md
+++ b/README.md
@@ -18,12 +18,19 @@ low level communication protocol by high level languages & constructs.
 
 ### ENV RECOMENDATIONS
 
+All of these are 'optional', however they are recommended. Only a C compiler,
+cmake and default system libraries are technically required to compile.
+
 1. node.js 0.10.26
 2. python 3.3.x or 2.7.x
-3. swig-v8 3.0.1
-4. doxygen 1.8.7
+3. swig-v8 3.0.1 (swig 2.x will work but you will not be able to build node.js
+module so comment out add_directories(javacsript) in src/CmakeLists.txt)
+4. doxygen (needed to generate even python doc)
+5. sphinx
+6. pygments
+7. pydoc
 
-To install swig-v8 the swig-v8-git package from AUR is helpful
+To install swig-v8 the swig-v8-git package from AUR is helpful.
 
 ## COMPILING
 
@@ -37,9 +44,6 @@ mkdir build/
 cmake ..
 make
 
-Install is currently unsuported. Javascript and python modules will be in
-build/src/{javascript, python}
-
 ## DEVELOPMENT
 
 Please fork the code on github and then send pull requests. Please avoid merges
@@ -53,4 +57,31 @@ see examples/
 *for node.js make sure that maajs.node is in the current dir and set export
 NODE_PATH=.*
 
-Python html documentation can be generated with **make pydoc**
+Simple python html documentation can be generated with **make pydoc**, this
+does not require the full doxygen/sphinx setup.
+
+## API Changelog
+
+When the API breaks in a small way there will be a changelog listed here
+
+**0.2.5**
+  * C++/Python/Node Enums/const names now do not contain MAA_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
+    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).
+  * 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
+
+**0.2.2**
+  * First version with API considered 'stable'