len0rd/FreeRTOS-Kernel
1
0
Fork 0
mirror of https://github.com/FreeRTOS/FreeRTOS-Kernel.git synced 2025-05-29 08:29:03 -04:00
Code Issues Packages Projects Releases Wiki Activity
FreeRTOS-Kernel/FreeRTOS/Demo/RISC-V_RV32_SiFive_HiFive1_GCC/freedom-metal/doc
History
Richard Barry 9bb072a2ab Base project to replace existing Freedom Studio project using latest Freedom Studio project format - builds and executes but does not yet include RTOS code.
2019-10-09 04:50:11 +00:00
..
html Base project to replace existing Freedom Studio project using latest Freedom Studio project format - builds and executes but does not yet include RTOS code. 2019-10-09 04:50:11 +00:00
sphinx Base project to replace existing Freedom Studio project using latest Freedom Studio project format - builds and executes but does not yet include RTOS code. 2019-10-09 04:50:11 +00:00
Makefile Base project to replace existing Freedom Studio project using latest Freedom Studio project format - builds and executes but does not yet include RTOS code. 2019-10-09 04:50:11 +00:00
mee-spec.md Base project to replace existing Freedom Studio project using latest Freedom Studio project format - builds and executes but does not yet include RTOS code. 2019-10-09 04:50:11 +00:00
README.md Base project to replace existing Freedom Studio project using latest Freedom Studio project format - builds and executes but does not yet include RTOS code. 2019-10-09 04:50:11 +00:00

README.md

Documentation Generation

Requirements

You'll need the following software:

Ubuntu

You can install the required software on Ubuntu with the following:

sudo apt install doxygen python3-sphinx python3-breathe graphviz python3-pydot
sudo apt install texlive-full latexmk

The second line can be omitted if you don't intend to build the PDF.

MacOS

You can install the required software on MacOS with the following:

brew install doxygen sphinx-doc graphviz
brew cask install mactex

The second line can be omitted if you don't intend to build the PDF.

Building the Docs

You can generate both the HTML and PDF documentation with

make

Or only the HTML or PDF docs using

make html

or

make pdf

You can clean the build files and outputs with

make clean