PThierry / tataouine

Wookey SDK

Readme first

To compile the overall documentation (sphinx, imagemagick and latex requested) :

• make doc

You can also read the documentation directly using the ReST files:

To compile the examples and to load them on a board, please, read quickstart guide:

• doc/sphinx/source/quickstart.rst

To have a deeper understanding of how to compile and how to flash a new firmware, you can also read the following documentation:

• doc/sphinx/source/tataouine/dependencies.rst
• doc/sphinx/source/tataouine/build.rst
• doc/sphinx/source/tataouine/flash.rst

The demo project are described here:

• doc/sphinx/source/demo.rst
• doc/sphinx/source/demo/blinky.rst
• doc/sphinx/source/demo/blinkyipc.rst

You can also compile the doc and read it here:

• build/armv7-m/wookey/doc/sphinx/html/index.html

The full documentation is also readable here:

• https://wookey-project.github.io/