aboutsummaryrefslogtreecommitdiffstats
path: root/README
diff options
context:
space:
mode:
authorMarti Bolivar <mbolivar@leaflabs.com>2011-06-11 19:25:29 -0400
committerMarti Bolivar <mbolivar@leaflabs.com>2011-06-11 20:05:33 -0400
commit0c2b3c667bf157dc2344e3dbc2aae0e11e37387b (patch)
tree3008ee192c80f17f640ebdeb870442e78415ce6b /README
parentd4b576fcadecf66b7b754af7d204bb6f3b4a9830 (diff)
downloadlibrambutan-0c2b3c667bf157dc2344e3dbc2aae0e11e37387b.tar.gz
librambutan-0c2b3c667bf157dc2344e3dbc2aae0e11e37387b.zip
Remove reST documentation, attendant updates.
The documentation covers topics not specifically relevant to libmaple, so it doesn't make sense for it to be part of the libmaple source distribution. Delete the docs/ tree, and prepare libmaple for use with the new leaflabs-docs repo, which will contain the docs from now on. * README: update to reflect this change * support/doxygen/Doxyfile: This is the old docs/Doxyfile * Makefile: Add a doxygen target * wirish/comm/HardwareSerial.h: fix reference to docs/. The comment informing maintainers that the HardwareSerial interface is documented by hand refers to the docs/ tree, which no longer exists. Update it to refer to the separate leaflabs-docs repository. * support/scripts/copy-to-ide: No longer build the documentation
Diffstat (limited to 'README')
-rw-r--r--README60
1 files changed, 44 insertions, 16 deletions
diff --git a/README b/README
index 456ea2f..f66ad03 100644
--- a/README
+++ b/README
@@ -5,24 +5,58 @@
| | | |_) | | | | | | (_| | |_) | | __/
|_|_|_.__/|_| |_| |_|\__,_| .__/|_|\___|
|_| by LeafLabs!
-
+ leaflabs.com
The latest version of this repository can be found here:
- http://github.com/leaflabs/libmaple
+ https://github.com/leaflabs/libmaple
General information
------------------------------------------------------------------------------
-A HOWTO on setting up this library for use in a Unix environment is
-available in our online HTML documentation:
+libmaple is a library for programming ST's STM32 line of Cortex M3
+microcontrollers. It has a pure C layer, libmaple proper, which does
+most of the work, and a C++ layer, Wirish, which provides high-level
+convenience functions and a Wiring/Arduino-compatible interface.
+
+libmaple's primary purpose is for use with LeafLabs' Maple line of
+microcontroller development boards (hence the name). However, it is
+portable across a variety of medium- and high-density STM32F1xx chips.
+For example, libmaple has successfully been ported to the ST Discovery
+kits.
+
+Using libmaple
+------------------------------------------------------------------------------
+
+The easiest way to use libmaple is in concert with the Maple IDE.
+Maple IDE, a sister project from LeafLabs, is an Arduino IDE fork
+usable for programming Maple boards, which includes libmaple and a
+compilation and upload toolchain:
+
+ http://leaflabs.com/docs/maple-ide-install.html
+
+Additionally, a HOWTO on setting up this library for use from the
+command line in a Unix environment is available in our online HTML
+documentation:
http://leaflabs.com/docs/unix-toolchain.html
-The HTML docs for this repository are automatically generated from the
-source code and the files under the top-level /docs/ directory. For
-more information, see /docs/README.
+Documentation, Etc.
+------------------------------------------------------------------------------
+
+HTML documentation for the latest release of libmaple/Maple IDE is
+available here:
+
+ http://leaflabs.com/docs/
+
+libmaple is well documented via Doxygen comments. The HTML
+documentation referenced above (which also includes the Doxygen
+output) is automatically generated from the source files in the
+leaflabs-docs repository. In order to obtain the leaflabs-docs
+repository, visit:
+
+ http://github.com/leaflabs/leaflabs-docs/
Our bugtracker is available at:
@@ -44,21 +78,14 @@ Repository Layout
Community-contributed resources. LeafLabs doesn't maintain the
contents of this directory, so it may get stale.
-/docs/
-
- Source code and build scripts for Doxygen and Sphinx
- documentation. The libmaple HTML documentation is generated from
- these files. It is available under http://leaflabs.com/docs/.
-
/examples/
Example code and test programs. Copy these to /main.cpp to compile them.
/libmaple/
- Lowest level definitions, routines, macros, and functions. This is
- the meat of the library. The Arduino-like compatibility layer is
- in /wirish/.
+ This is the meat of the library. C only, no C++. The
+ Arduino-like compatibility layer (in C++) is in /wirish/.
/libraries/
@@ -97,6 +124,7 @@ Repository Layout
make/ Additional scripts used by the top-level Makefile.
openocd/ OpenOCD scripts for JTAG debugging.
scripts/ Miscellany.
+ doxygen/ Doxygen configuration.
stm32loader.py Script for uploading via the built-in USART bootloader.
/wirish/