You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Piotr Esden-Tempski
204eb047b4
|
12 years ago | |
|---|---|---|
| .. | ||
| cm3 | 12 years ago | |
| efm32g | 12 years ago | |
| efm32gg | 12 years ago | |
| efm32lg | 12 years ago | |
| efm32tg | 12 years ago | |
| lm3s | 12 years ago | |
| lm4f | 12 years ago | |
| lpc13xx | 12 years ago | |
| lpc17xx | 12 years ago | |
| lpc43xx | 12 years ago | |
| stm32f1 | 12 years ago | |
| stm32f2 | 12 years ago | |
| stm32f4 | 12 years ago | |
| stm32l1 | 12 years ago | |
| Doxyfile | 12 years ago | |
| Doxyfile_common | 12 years ago | |
| DoxygenLayout.xml | 12 years ago | |
| HACKING | 12 years ago | |
| Makefile | 12 years ago | |
| README | 12 years ago | |
README
libopencm3 Documentation
14 September 2012 (C) K Sarkies
-------------------------------
To generate all documentation run 'make doc' in the doc directory, or
for html documentation only run 'make html' (much faster). This runs doxygen
for each of the processor families then integrates the whole.
Alternatively run 'make doc' in the top directory to make html documentation.
LaTeX and pdf documentation is currently very large in size.
This requires doxygen v 1.8.2 or later.
HTML, LaTeX, and pdf output can be produced.
Generation of HTML
------------------
To view HTML, point a browser to libopencm3/doc/html/index.html.
Generation of PDF
-----------------
The pdf is generated via LaTeX. The pdf files are placed in the
doc directory. Each file contains all documentation for the core and common
features. The resulting files are huge.