gadget-kspconsole/unicore-mx/doc
Daniele Lacamera b8a7ffcd31 Initial import
2023-11-27 15:16:45 +01:00
..
cm3 Initial import 2023-11-27 15:16:45 +01:00
efm32g Initial import 2023-11-27 15:16:45 +01:00
efm32gg Initial import 2023-11-27 15:16:45 +01:00
efm32lg Initial import 2023-11-27 15:16:45 +01:00
efm32tg Initial import 2023-11-27 15:16:45 +01:00
lm3s Initial import 2023-11-27 15:16:45 +01:00
lm4f Initial import 2023-11-27 15:16:45 +01:00
lpc13xx Initial import 2023-11-27 15:16:45 +01:00
lpc17xx Initial import 2023-11-27 15:16:45 +01:00
lpc43xx Initial import 2023-11-27 15:16:45 +01:00
sam3a Initial import 2023-11-27 15:16:45 +01:00
sam3n Initial import 2023-11-27 15:16:45 +01:00
sam3s Initial import 2023-11-27 15:16:45 +01:00
sam3u Initial import 2023-11-27 15:16:45 +01:00
sam3x Initial import 2023-11-27 15:16:45 +01:00
stm32f0 Initial import 2023-11-27 15:16:45 +01:00
stm32f1 Initial import 2023-11-27 15:16:45 +01:00
stm32f2 Initial import 2023-11-27 15:16:45 +01:00
stm32f3 Initial import 2023-11-27 15:16:45 +01:00
stm32f4 Initial import 2023-11-27 15:16:45 +01:00
stm32f7 Initial import 2023-11-27 15:16:45 +01:00
stm32l0 Initial import 2023-11-27 15:16:45 +01:00
stm32l1 Initial import 2023-11-27 15:16:45 +01:00
stm32l4 Initial import 2023-11-27 15:16:45 +01:00
usb Initial import 2023-11-27 15:16:45 +01:00
vf6xx Initial import 2023-11-27 15:16:45 +01:00
Doxyfile Initial import 2023-11-27 15:16:45 +01:00
Doxyfile_common Initial import 2023-11-27 15:16:45 +01:00
DoxygenLayout.xml Initial import 2023-11-27 15:16:45 +01:00
HACKING Initial import 2023-11-27 15:16:45 +01:00
index.html Initial import 2023-11-27 15:16:45 +01:00
Makefile Initial import 2023-11-27 15:16:45 +01:00
README Initial import 2023-11-27 15:16:45 +01:00

unicore-mx 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 unicore-mx/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