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 5609749411 doc: drop unused tex files 7 years ago
..
efm32g doc: drop unused tex files 7 years ago
efm32gg doc: drop unused tex files 7 years ago
efm32hg doc: drop unused tex files 7 years ago
efm32lg doc: drop unused tex files 7 years ago
efm32tg doc: drop unused tex files 7 years ago
lm3s doc: drop unused tex files 7 years ago
lm4f doc: drop unused tex files 7 years ago
lpc13xx doc: drop unused tex files 7 years ago
lpc17xx doc: drop unused tex files 7 years ago
lpc43xx doc: drop unused tex files 7 years ago
sam3a doc: drop unused tex files 7 years ago
sam3n doc: drop unused tex files 7 years ago
sam3s doc: drop unused tex files 7 years ago
sam3u doc: drop unused tex files 7 years ago
sam3x doc: drop unused tex files 7 years ago
stm32f0 doc: drop unused tex files 7 years ago
stm32f1 doc: drop unused tex files 7 years ago
stm32f2 doc: drop unused tex files 7 years ago
stm32f3 doc: drop unused tex files 7 years ago
stm32f4 doc: drop unused tex files 7 years ago
stm32f7 doc: drop unused tex files 7 years ago
stm32l0 doc: drop unused tex files 7 years ago
stm32l1 doc: drop unused tex files 7 years ago
stm32l4 doc: drop unused tex files 7 years ago
vf6xx doc: drop unused tex files 7 years ago
Doxyfile Fix a number of top level doxygen issues. 11 years ago
Doxyfile_common doc: enable @deprecated generation 7 years ago
DoxygenLayout.xml doxygen: efm32hg: update doxygen templates to include efm32hg 7 years ago
HACKING doc: drop unused tex files 7 years ago
Makefile efm32hg: add basic makefile, interrupts, device information 7 years ago
README docs: note dependencies for PDF generation 11 years ago
index.html [DOXYGEN] Add links to the HTML pages for easy debugging of pages 11 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