From a697512eed271782cfb099a17076090afaf527c3 Mon Sep 17 00:00:00 2001 From: Brendan Le Foll Date: Mon, 19 May 2014 11:05:43 +0100 Subject: [PATCH] cmake: version bump to 0.2.5 Signed-off-by: Brendan Le Foll --- CMakeLists.txt | 2 +- README.md | 24 +++++++++++++++++------- 2 files changed, 18 insertions(+), 8 deletions(-) diff --git a/CMakeLists.txt b/CMakeLists.txt index 32693a8..6888305 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -14,7 +14,7 @@ include (GetGitRevisionDescription) git_describe (VERSION "--tags") if ("x_${VERSION}" STREQUAL "x_GIT-NOTFOUND") message (WARNING " - Install git to compile a production libmaa!") - set (VERSION "v0.2.4-dirty") + set (VERSION "v0.2.5-dirty") endif () message (INFO " - MAA Version ${VERSION}") diff --git a/README.md b/README.md index 5f6d96e..9d6b0dc 100644 --- a/README.md +++ b/README.md @@ -18,12 +18,18 @@ 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. 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 +43,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,12 +56,19 @@ 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 -- 2.7.4