Permalink
Browse files

Update the README.

We're more portable since last writing. We also shamefully ignore the
bugtracker and blocking changes pages, so drop those for now. Other
tweaks and fixups.

Signed-off-by: Marti Bolivar <mbolivar@leaflabs.com>
  • Loading branch information...
1 parent f3abc64 commit 8a2035659dcaef6ff776bf3591f7891391a5f264 Marti Bolivar committed Jun 29, 2012
Showing with 10 additions and 19 deletions.
  1. +10 −19 README
View
@@ -22,11 +22,9 @@ 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.
+libmaple is designed for portability, and currently runs on a variety
+of STM32F1 performance and value line MCUs, with experimental support
+for STM32F2 MCUs.
Using libmaple
------------------------------------------------------------------------------
@@ -39,8 +37,7 @@ 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:
+command line in a Unix environment is available here:
http://leaflabs.com/docs/unix-toolchain.html
@@ -60,14 +57,6 @@ repository, visit:
http://github.com/leaflabs/leaflabs-docs/
-Our bugtracker is available at:
-
- http://code.google.com/p/leaflabs/issues/list
-
-For changes that block official releases, see our wiki:
-
- http://wiki.leaflabs.com/index.php?title=Blocking_Changes
-
Repository Layout
------------------------------------------------------------------------------
@@ -107,26 +96,28 @@ Repository Layout
/Makefile
- libmaple build instructions for GNU Make.
+ libmaple build instructions for GNU Make. (This is supplemented by
+ build-targets.mk, the rules.mk files throughout the tree, and the
+ files in support/make/).
/notes/
Unstructured text notes that may be useful.
/README
- This file.
+ This file ;).
/support/
Support files and scripts for various purposes.
gdb/ GDB scripts.
ld/ Linker scripts.
- make/ Additional scripts used by the top-level Makefile.
+ make/ Additional files used by the top-level Makefile.
scripts/ Miscellany.
doxygen/ Doxygen configuration.
- stm32loader.py Script for uploading via the built-in USART bootloader.
+ stm32loader.py Upload script for the STM32's built-in USART bootloader.
/wirish/

0 comments on commit 8a20356

Please sign in to comment.