aboutsummaryrefslogtreecommitdiffstats
path: root/docs/source/libmaple.rst
diff options
context:
space:
mode:
authorMarti Bolivar <mbolivar@mit.edu>2010-12-21 10:27:37 -0500
committerMarti Bolivar <mbolivar@mit.edu>2010-12-21 10:27:37 -0500
commitc45bccad44187da27505cf5808424e709e3f54a1 (patch)
tree18a459a50f8d0551ba046e30462c93999d982725 /docs/source/libmaple.rst
parent84fd2532a7f23d20354ff590790b3f892cb7e7d7 (diff)
parentd5ad2a27f4e69e6cc9324331945937c983c30366 (diff)
downloadlibrambutan-c45bccad44187da27505cf5808424e709e3f54a1.tar.gz
librambutan-c45bccad44187da27505cf5808424e709e3f54a1.zip
Merge branch 'master' into debug-serialusb.
Chose debug-serialusb version in cases of conflict. Conflicts: libmaple/usb/usb_callbacks.c
Diffstat (limited to 'docs/source/libmaple.rst')
-rw-r--r--docs/source/libmaple.rst23
1 files changed, 13 insertions, 10 deletions
diff --git a/docs/source/libmaple.rst b/docs/source/libmaple.rst
index a018cd7..b76c7c8 100644
--- a/docs/source/libmaple.rst
+++ b/docs/source/libmaple.rst
@@ -2,19 +2,19 @@
.. _libmaple:
-====================
- libmaple Reference
-====================
+``libmaple`` Reference
+======================
.. image:: /_static/img/libmaple-screenshot-small.png
:align: center
:alt: libmaple screenshot
-`LeafLabs libmaple <libmaple-libmaple>`_ is the low level library we have developed for for the ARM
-Cortex-M3 chips manufactured by STMicroelectronics used in the Maple
-boards (the `STM32F103x`_ series). We found the generic peripheral
-libraries too painful to build on top of, and reimplemented the
-functionality we needed in a simpler (and less general) form.
+`LeafLabs libmaple <libmaple-libmaple>`_ is the low level library we
+have developed for for the ARM Cortex-M3 chips manufactured by
+STMicroelectronics used in the Maple boards (the `STM32F103x`_
+series). We found the generic peripheral libraries too painful to
+build on top of, and reimplemented the functionality we needed in a
+simpler (and less general) form.
.. _libmaple-libmaple: http://github.com/leaflabs/libmaple
.. _STM32F103x: http://www.st.com/stonline/stappl/productcatalog/app?path=/pages/stcom/PcStComPartNumberSearch.searchPartNumber&search=stm32f103
@@ -22,7 +22,7 @@ functionality we needed in a simpler (and less general) form.
This library is transparently included in the `Maple IDE
<http://leaflabs.com/docs/maple-ide/>`_, but we develop it separately
using good old Unix command line tools and release it for advanced
-users who might chafe at the “sketch” programming model of the
+users who might chafe at the "sketch" programming model of the
IDE. Included are some examples, a Makefile, and the compatibility
wrappers and code to imitate the Arduino programming library.
@@ -36,4 +36,7 @@ wrappers and code to imitate the Arduino programming library.
:maxdepth: 2
Unix Toolchain Quickstart <unix-toolchain>
- libmaple API reference <libmaple-api>
+ Guide to using GCC's ARM target <arm-gcc>
+
+.. TODO LATER create, style, and host a pure Doxygen libmaple
+.. reference docs. This implies determining a stable API.