aboutsummaryrefslogtreecommitdiffstats
path: root/docs/README
diff options
context:
space:
mode:
authorbnewbold <bnewbold@robocracy.org>2014-08-27 17:36:11 -0400
committerbnewbold <bnewbold@robocracy.org>2014-08-27 17:42:22 -0400
commit34b766c9d5f778762069938c71e052fa40455d1c (patch)
tree3a2b77e636b222fecff6366218cf7845029afecf /docs/README
parent746d6fecf86572c9fe95dbbffdf541a8d3875dd0 (diff)
parentadd7e54ccaf61859874527feda2b51ea172ce697 (diff)
downloadlibrambutan-34b766c9d5f778762069938c71e052fa40455d1c.tar.gz
librambutan-34b766c9d5f778762069938c71e052fa40455d1c.zip
merge libmaple docs ("leaflabs-docs") into ./docs
In the past, libample documentation was forked out of this repository because the documentation had increased in scope. For the librambutan, and the rambutan project in general, we will try to keep documentation closer to the source code, so the librambutan-specific documentation should live here. Other sections of leaflabs-docs will be culled in a following commit. This merge attempts to maintain history by using a subtree strategy. Followed directions at: http://nuclearsquid.com/writings/subtree-merging-and-you/ Full history for files should be accessible using the "--follow" flag to git log, eg: git log --follow docs/source/adc.rst It should be possible to pull patches from leaflabs-docs with: git pull -s subtree leaflabs-docs master ... at least until the docs in this repository diverge significantly.
Diffstat (limited to 'docs/README')
-rw-r--r--docs/README24
1 files changed, 24 insertions, 0 deletions
diff --git a/docs/README b/docs/README
new file mode 100644
index 0000000..60fb888
--- /dev/null
+++ b/docs/README
@@ -0,0 +1,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