From c5e6b90ba80fb02da3f4f94e85912727e6d94360 Mon Sep 17 00:00:00 2001 From: Marti Bolivar Date: Sun, 6 May 2012 23:58:28 -0400 Subject: Redo source/libmaple.rst. This page is not a good introduction. Make edits for clarity and hopefully ease of use. Signed-off-by: Marti Bolivar --- source/libmaple.rst | 47 ++++++++++++++++++++++++++--------------------- 1 file changed, 26 insertions(+), 21 deletions(-) diff --git a/source/libmaple.rst b/source/libmaple.rst index 0517f44..dce9ee6 100644 --- a/source/libmaple.rst +++ b/source/libmaple.rst @@ -5,33 +5,39 @@ ``libmaple`` ============ -LeafLabs' libmaple (`source code on GitHub -`_) is the library we have -developed for the `STM32 `_ line of ARM -Cortex M3 microcontrollers. Its high-level interfaces are -:ref:`largely compatible ` with the AVR -libraries written for the `Arduino `_ and `Wiring -`_ development boards. +LeafLabs' libmaple is the open source library we have developed for +programming the `STM32 `_ line of +microcontrollers. Libmaple's `source is on GitHub +`_; :ref:`patches are welcome +`. .. _libmaple-vs-wirish: -libmaple is split into two pieces: a lower level layer written in C, -which we call *libmaple proper* (in the `libmaple/ -`_ -directory of the source repository), and the Wiring-style C++ API -written on top of it, called *Wirish* (in `wirish/ -`_; the -wirish APIs are :ref:`summarized here `, with an :ref:`index -here `). +Libmaple is split into two pieces: + +- A low-level layer, written in C, called *libmaple proper*, located + in the `libmaple/ + `_ + subdirectory of the source repository. + +- A high-level layer, written in C++, called *wirish*, in the `wirish/ + `_ + subdirectory. + +Wirish is :ref:`largely compatible ` with the +AVR libraries written for the `Arduino `_ and +`Wiring `_ development boards. The Wirish +:ref:`language` page is a good summary of what Wirish provides; a +:ref:`complete Wirish API index ` is also +available. :ref:`Wirish libraries ` are documented +separately. libmaple is bundled with the :ref:`Maple IDE `. However, we develop it separately, and :ref:`release it standalone ` for advanced users who might chafe at the "sketch" -programming model of the IDE. - -As always, :ref:`patches are welcome `. - -**Contents:** +programming model of the IDE. The following pages document libmaple +proper. As such, they're intended for advanced users who know how to +write C. .. toctree:: :maxdepth: 1 @@ -40,4 +46,3 @@ As always, :ref:`patches are welcome `. libmaple/apis libmaple/contributing libmaple/coding-standard - -- cgit v1.2.3