diff options
Diffstat (limited to 'README')
| -rw-r--r-- | README | 60 |
1 files changed, 44 insertions, 16 deletions
@@ -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/ |