docs: Add docs/ folder with in depth topics as well as DoxygenLayout.xml file
* C headers now have @briefs and include examples * Examples have altered 'Interesting' Sections Signed-off-by: Brendan Le Foll <brendan.le.foll@intel.com>
This commit is contained in:
27
docs/building.md
Normal file
27
docs/building.md
Normal file
@@ -0,0 +1,27 @@
|
||||
Building libmaa {#building}
|
||||
===============
|
||||
|
||||
libmaa 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.
|
||||
|
||||
~~~~~~~~~~~~~{.sh}
|
||||
mkdir build
|
||||
cd build
|
||||
cmake ..
|
||||
make
|
||||
~~~~~~~~~~~~~
|
||||
|
||||
Our cmake configure has a number of options, `cmake -i` will ask you all sorts
|
||||
of interesting questions, you can disable swig modules, build documentation
|
||||
etc...
|
||||
|
||||
Few recommended options:
|
||||
Changing install path from /usr/local to /usr
|
||||
-DCMAKE_INSTALL_PREFIX:PATH=/usr
|
||||
|
||||
Building debug build:
|
||||
-DCMAKE_BUILD_TYPE=DEBUG
|
||||
|
||||
Using clang instead of gcc:
|
||||
-DCMAKE_C_COMPILER=/usr/bin/clang -DCMAKE_CXX_COMPILER=/usr/bin/clang
|
||||
|
||||
17
docs/contributing.md
Normal file
17
docs/contributing.md
Normal file
@@ -0,0 +1,17 @@
|
||||
Contributing to libmaa {#contributing}
|
||||
======================
|
||||
|
||||
libmaa is an opensource project and we are actively looking for people to help
|
||||
with:
|
||||
|
||||
- Writing platform supports for all types of embedded boards running linux
|
||||
- People to write cool samples
|
||||
- People to extend the functionality
|
||||
|
||||
The recommended method to contribute is to fork on github, and then send pull
|
||||
requests to the main project. Questions can be also be asked and issues raised
|
||||
on github.
|
||||
|
||||
If you'd rather not use github you are more than welcome to send git formatted
|
||||
patches to brendan.le.foll@intel.com.
|
||||
|
||||
10
docs/galileorevd.md
Normal file
10
docs/galileorevd.md
Normal file
@@ -0,0 +1,10 @@
|
||||
Galileo Rev D {#galileorevd}
|
||||
=============
|
||||
|
||||
Galileo is a microcontroller board based on the Intel® Quark SoC X1000
|
||||
Application Processor, a 32-bit Intel Pentium-class system on a chip.
|
||||
|
||||
The rev D board has the following limitations in libmaa:
|
||||
|
||||
- gpio register access via /dev/uio is limited to pin2 and 3
|
||||
- gpio interupts will only work on GPIO_EDGE_BOTH
|
||||
Reference in New Issue
Block a user