aboutsummaryrefslogtreecommitdiffstats
path: root/docs/README
blob: 60fb888046815eaf1d6f026eb8d27bfb881b321c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
This repository contains source files used to generate the
documentation for LeafLabs' libmaple and Maple IDE projects [*]. The
HTML documentation generated from these sources is available online:

    http://leaflabs.com/docs/

The above URL is the recommended way for users to read the
documentation.  The docs for the latest release are always available
there.

Older versions are here:

    http://static.leaflabs.com/pub/leaflabs/maple-docs/

The file README-building.txt explains how to build the HTML docs.

The file README-maintainers.txt contains important information for
maintainers of the documentation (e.g. how to add docs for a new
board, how to cut a release version of the docs, etc.).

[*] libmaple and Maple IDE themselves are in separate repositories:

    https://github.com/leaflabs/libmaple
    https://github.com/leaflabs/maple-ide