README.md

   1 MAA - Low Level Skeleton Library for Communication on Intel platforms
   2 ==============
   3
   4 Library in C/C++ to interface with Galileo & other Intel platforms over:
   5
   6 - I2C
   7 - SPI
   8 - GPIO
   9 - PWM
  10 - AIO
  11
  12 In a structured and sane API with port nanmes/numbering that match boards &
  13 with bindings to javascript & python.
  14
  15 The intent is to make it easier for developers and sensor manufacturers to map
  16 their sensors & actuators on top of supported hardware and to allow control of
  17 low level communication protocol by high level languages & constructs.
  18
  19 ### ENV RECOMENDATIONS
  20
  21 1. node.js 0.10.26
  22 2. python 3.3.x or 2.7.x
  23 3. swig-v8 3.0.1
  24 4. doxygen 1.8.7
  25
  26 To install swig-v8 the swig-v8-git package from AUR is helpful
  27
  28 ## COMPILING
  29
  30 NOTE: The **only** supported cmake build configuration is to have the build/ dir
  31 inside of the repo/tarball.
  32
  33 *if swig-v8 is not in your default path you can try run cmake with
  34 "-DCMAKE_PREFIX_PATH="/path/to/swig-v8"*
  35
  36 mkdir build/
  37 cmake ..
  38 make
  39
  40 Install is currently unsuported. Javascript and python modules will be in
  41 build/src/{javascript, python}
  42
  43 ## DEVELOPMENT
  44
  45 Please fork the code on github and then send pull requests. Please avoid merges
  46 in your forks. I will also accept patches sent in git style with signoffs to
  47 brendan.le.foll@intel.com
  48
  49 ## USING
  50
  51 see examples/
  52
  53 *for node.js make sure that maajs.node is in the current dir and set export
  54 NODE_PATH=.*
  55
  56 Python html documentation can be generated with **make pydoc**