Fork of libopencm3 with some minor additions
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.
 
 
 
 
 
Karl Palsson 4e70d06d63 stm32g4: Add basic support 3 years ago
..
efm32ezr32wg doc: properly define ARM_ARCH_xxx 4 years ago
efm32g doc: properly define ARM_ARCH_xxx 4 years ago
efm32gg doc: properly define ARM_ARCH_xxx 4 years ago
efm32hg doc: properly define ARM_ARCH_xxx 4 years ago
efm32lg doc: properly define ARM_ARCH_xxx 4 years ago
efm32tg doc: properly define ARM_ARCH_xxx 4 years ago
efm32wg doc: properly define ARM_ARCH_xxx 4 years ago
gd32f1x0 doc: properly define ARM_ARCH_xxx 4 years ago
lm3s doc: properly define ARM_ARCH_xxx 4 years ago
lm4f doc: properly define ARM_ARCH_xxx 4 years ago
lpc13xx doc: properly define ARM_ARCH_xxx 4 years ago
lpc17xx doc: properly define ARM_ARCH_xxx 4 years ago
lpc43xx doc: properly define ARM_ARCH_xxx 4 years ago
lpc43xxm0 doc: properly define ARM_ARCH_xxx 4 years ago
lpc43xxm4 doc: properly define ARM_ARCH_xxx 4 years ago
msp432e4 doc: properly define ARM_ARCH_xxx 4 years ago
pac55xx Qorvo pac55xx: initial support 3 years ago
sam3a doc: properly define ARM_ARCH_xxx 4 years ago
sam3n doc: properly define ARM_ARCH_xxx 4 years ago
sam3s doc: properly define ARM_ARCH_xxx 4 years ago
sam3u doc: properly define ARM_ARCH_xxx 4 years ago
sam3x doc: properly define ARM_ARCH_xxx 4 years ago
sam4l doc: properly define ARM_ARCH_xxx 4 years ago
samd doc: properly define ARM_ARCH_xxx 4 years ago
stm32f0 doc: properly define ARM_ARCH_xxx 4 years ago
stm32f1 doc: properly define ARM_ARCH_xxx 4 years ago
stm32f2 doc: properly define ARM_ARCH_xxx 4 years ago
stm32f3 doc: properly define ARM_ARCH_xxx 4 years ago
stm32f4 doc: properly define ARM_ARCH_xxx 4 years ago
stm32f7 doc: properly define ARM_ARCH_xxx 4 years ago
stm32g0 doc: properly define ARM_ARCH_xxx 4 years ago
stm32g4 stm32g4: Add basic support 3 years ago
stm32h7 stm32h7: Initial introduction into libopencm3. 3 years ago
stm32l0 doc: properly define ARM_ARCH_xxx 4 years ago
stm32l1 doc: properly define ARM_ARCH_xxx 4 years ago
stm32l4 doc: properly define ARM_ARCH_xxx 4 years ago
swm050 doc: properly define ARM_ARCH_xxx 4 years ago
templates doc: properly define ARM_ARCH_xxx 4 years ago
vf6xx doc: properly define ARM_ARCH_xxx 4 years ago
Doxyfile Fix a number of top level doxygen issues. 9 years ago
Doxyfile_common doc: enable @deprecated generation 5 years ago
HACKING doc: drop unused tex files 5 years ago
Makefile stm32g4: Add basic support 3 years ago
README docs: note dependencies for PDF generation 9 years ago
index.html [DOXYGEN] Add links to the HTML pages for easy debugging of pages 9 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.


Requirements
------------
On Fedora 19, the following packages (at least!) are needed to build the pdf
output

texlive texlive-sectsty texlive-tocloft texlive-xtab texlive-multirow