====== Open-CoRoCo software ======

===== Environment setup =====
TODO: install packages
TODO: install libopencm3{,-plus}, omni-base

===== Running tests =====

===== Debug process =====

==== Required packages ====
The following packages should be installed:

  - arm-none-eabi-gdb
  - openocd
  - STLINK

==== Debug ====
The process to debug the stm32f4-discovery is the following:

  * Connect the stm32f4-discovery with the programming and serial usb.
  * ''make'' and ''make flash'' the program to debug.
  * Create a file with the name **openocd.cfg** with the follow content.

<code>
source [find interface/stlink-v2-1.cfg]
source [find target/stm32f4x.cfg]
init
$_TARGETNAME configure -rtos ChibiOS
</code>

  * Open a terminal in the same directory where the file was created and run ''openocd''. Keep that terminal open.
  * If the before command doesn't work, change the ''interface stlink version'' and run again.
  * Open another terminal where the program to debug is and run ''arm-none-eabi-gdb -tui <program to debug>.elf''. The ''-tui'' flag enables a kind of command window that shows the code.
  * Into the dbg prompt run ''target extended-remote :3333'' to connect gdb to openocd.
  * Now you can debug!!!

==== Considerations ====
Sometimes openocd fails to detect ChibiOs and this is an [[https://github.com/Meta-Team/Insouled_ChibiOS_CPP/issues/1|open issue]]
===== Current repository state =====
TODO: sw structure

===== Code colaboration =====
TODO: when add types, functions and how to add them