kingkevin
/
stm32f1
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

README: add link to manual

This commit is contained in:
King Kévin 2018-03-11 13:19:24 +01:00
parent 41976d0af8
commit ab3955b15b
1 changed files with 23 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

40
README.md
View File

@ -1,4 +1,4 @@
This firmware for the [BusVoodoo](https://wiki.cuvoodoo.info/doku.php?id=busvoodoo).
This firmware for the [BusVoodoo](https://bus.cuvoodoo.info/).
project
=======
@ -9,24 +9,14 @@ summary
The BusVoodoo is a multi-protocol debugging adapter.
This tool allows to quickly communicate with various other electronic devices.
An overview of the BusVoodoo can be found [here](https://bus.cuvoodoo.info/)
A more detailed manual is available [here](https://bus.cuvoodoo.info/manual/).
The following information will focus on the software development.
board
=====
The BusVoodoo uses a [custom board](https://wiki.cuvoodoo.info/doku.php?id=busvoodoo#software_hardware) based on a [STM32F103RC](http://www.st.com/en/microcontrollers/stm32f103rc.html) micro-controller.
connections
===========
The BusVoodoo provides:
- a USB port for a connection to the PC
- an I/O port for the 0-5V protocols
- an I2C port to control an OLED display
- a programming port for debugging usindg SWD and UART
Check the [BusVoodoo hardware](https://git.cuvoodoo.info/busvoodoo_hardware/about/) files for more details.
All pins are configured using `define`s in the corresponding source code.
The BusVoodoo uses a [custom board](hhttps://bus.cuvoodoo.info/manual/index.html#_hardware_development) based on a [STM32F103RC](http://www.st.com/en/microcontrollers/stm32f103rc.html) micro-controller.
code
====
@ -34,6 +24,15 @@ code
dependencies
------------
To develop the firmware, following Linux packages are required:
- _arm-none-eabi-gcc_ to compile the source code
- _arm-none-eabi-binutils_ to create the firmware binaries
- _arm-none-eabi-gdb_ to debug the firmware
- _rake_ automate development steps
- _openocd_ to flash and debug over SWD (when using an ST-Link V2 adapter)
- _doxygen_ to compile the documentation
The source code uses the [libopencm3](http://libopencm3.org/) library.
The projects is already a git submodules.
It will be initialized when compiling the firmware.
@ -42,12 +41,19 @@ Alternatively you can run once: `git submodule init` and `git submodule update`.
firmware
--------
To compile the firmware run `rake`.
To compile the firmware files run `rake`.
This will generate two firmware:
- _bootloader_: a USB DFU bootlaoder
- _application_: the main application
documentation
-------------
To generate doxygen documentation run `rake doc`.
The documentation describing all files, functions, and variables will be available in the _doc_ folder.
Further comments are in the source code.
flash
-----