aboutsummaryrefslogtreecommitdiffstats
path: root/docs/source/libmaple.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/source/libmaple.rst')
-rw-r--r--docs/source/libmaple.rst58
1 files changed, 28 insertions, 30 deletions
diff --git a/docs/source/libmaple.rst b/docs/source/libmaple.rst
index 8cc39a3..375e821 100644
--- a/docs/source/libmaple.rst
+++ b/docs/source/libmaple.rst
@@ -5,37 +5,35 @@
``libmaple``
============
-.. 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.
-
-.. _libmaple-libmaple: http://github.com/leaflabs/libmaple
-.. _STM32F103x: http://www.st.com/stonline/stappl/productcatalog/app?path=/pages/stcom/PcStComPartNumberSearch.searchPartNumber&search=stm32f103
-
-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
-IDE. Included are some examples, a Makefile, and the compatibility
-wrappers and code to imitate the Arduino programming library.
-
-**Check out the latest source**::
-
- git clone git://github.com/leaflabs/libmaple.git
-
-**Table of contents:**
+LeafLabs' libmaple (`source code on Github
+<https://github.com/leaflabs/libmaple>`_) is the library we have
+developed for the `STM32 <http://www.st.com/stonline>`_ line of ARM Cortex M3
+microcontrollers. Its high-level interfaces are :ref:`largely
+compatible <arduino-compatibility>` with the AVR libraries written for
+the `Arduino <http://arduino.cc>`_ and `Wiring
+<http://wiring.org.co/>`_ development boards.
+
+libmaple is split into two pieces: a lower level layer written in pure
+C, which we call *libmaple proper* (in the `libmaple/
+<https://github.com/leaflabs/libmaple/tree/master/libmaple>`_
+directory of the source repository), and the Wiring-style C++ API
+written on top of it, called *Wirish* (in `wirish/
+<https://github.com/leaflabs/libmaple/tree/master/wirish>`_).
+
+libmaple is bundled with the :ref:`Maple IDE <ide>`. However, we
+develop it separately, and :ref:`release it standalone
+<unix-toolchain>` for advanced users who might chafe at the "sketch"
+programming model of the IDE.
+
+As always, :ref:`patches are welcome <libmaple-contributing>`.
+
+**Contents:**
.. toctree::
- :maxdepth: 2
+ :maxdepth: 1
- Guide to using GCC's ARM target <arm-gcc>
+ libmaple/overview
+ libmaple/apis
+ libmaple/contributing
+ libmaple/coding-standard
-.. TODO LATER create, style, and host a pure Doxygen libmaple
-.. reference docs. This implies determining a stable API.