Private
Public Access
2
0

docs: fix some poor spelling & phrasing in docs

Signed-off-by: Brendan Le Foll <brendan.le.foll@intel.com>
This commit is contained in:
Brendan Le Foll
2015-02-09 16:40:47 +00:00
parent fca0efa254
commit 2dc79dde6f
4 changed files with 74 additions and 73 deletions

View File

@@ -3,16 +3,16 @@ Building libmraa {#building}
libmraa uses cmake in order to make compilation relatively painless. Cmake runs
build out of tree so the recommended way is to clone from git and make a build/
directory.
directory inside the clone directory.
## Build dependencies
Not all these are required but if you're unsure of what you're doing this is
what you'll need:
* swig 3.0.4+
* git
* python 2.7 or 3.4+ (you'll need not just the interpreter but python-dev)
* nodejs 0.10.x (you'll need not just the interneter but nodejs-dev)
* cmake 2.8.8+
* [SWIG](http://swig.org) 3.0.5+
* [git](http://git-scm.com)
* [python](http://python.org) 2.7 or 3.4+ (you'll need not just the interpreter but python-dev)
* [node.js](http://nodejs.org) 0.10.x (you'll need not just the interpreter but nodejs-dev)
* [CMake](http://cmake.org) 2.8.8+
## Basic build steps
@@ -31,46 +31,49 @@ got.
Our cmake configure has a number of options, cmake-gui or ccmake (cmake -i is
no longer with us :() can show you all the options. A few of the more common
ones are listed below - note that when the option starts with CMAKE_ it's an
ones are listed below. Note that when the option starts with CMAKE_ it's an
option that is made available by cmake and will be similar in all cmake
projects. You need to add them after `cmake` but before `..`.
A few recommended options:
Changing install path from /usr/local to /usr
Changing install path from /usr/local to /usr:
-DCMAKE_INSTALL_PREFIX:PATH=/usr
Building debug build - adds -g and disables optimisations - this will force a full rebuild:
Building debug build - adds -g and disables optimisations - this will force a
full rebuild:
-DCMAKE_BUILD_TYPE=DEBUG
Using clang instead of gcc:
-DCMAKE_C_COMPILER=/usr/bin/clang -DCMAKE_CXX_COMPILER=/usr/bin/clang++
Building with an older version of swig (swig < 3.0.2) requires the disabling of javascript:
Building with an older version of SWIG (< 3.0.2) requires the disabling of javascript:
-DBUILDSWIGNODE=OFF
Disabling python module building
Disabling python module building:
-DBUILDSWIGPYTHON=OFF
Building doc, this will require sphinx & doxygen
Building doc, this will require [SPHINX](http://sphinx-doc.org) &
[Doxygen](http://doxygen.org):
-BUILDDOC=ON
## Dependancies continued
## Dependencies continued
You'll need at least swig version 3.0.2 and we recommend 3.0.4 to build the
You'll need at least SWIG version 3.0.2 and we recommend 3.0.5 to build the
javascript & python modules. If your version of SWIG is older than this then
please see below for disabling SWIGNODE otherwise you will get a weird build
failure when building the js module. The python module builds with swig 2.x.
please see above for disabling SWIGNODE. Otherwise you will get a weird build
failure when building the javascript module. The python module builds with SWIG
2.x.
The basic build steps are as follow, we'll assume you're building from git,
note that if you compile with git installed your version of mraa will be tagged
-dirty. This simply means git wasn't installed or that you where building form
a tarball. You can modify build/src/version.c before running make if this is
incorrect. The instructions listed here all assume that build/ is an empty dir
that lives inside the cloned repository of mraa.
During the build, we'll assume you're building from git, note that if you
compile with git installed your version of mraa will be tagged -dirty. This
simply means git wasn't installed or that you where building form a tarball.
You can modify build/src/version.c before running make if this is incorrect.
The instructions listed here all assume that build/ is an empty dir that lives
inside the cloned repository of mraa.
If you have multiple versions of python then mraa can get confused, we
recommend using virtualenv to select which version of python you want. We test
2.7 the most but swig will generate valid 3.x python code but we do not
2.7 the most but SWIG will generate valid 3.x python code but we do not
generally support building both at once.
## Using a yocto/oe toolchain