aboutsummaryrefslogtreecommitdiffstats
path: root/README
diff options
context:
space:
mode:
authorbnewbold <bnewbold@robocracy.org>2010-03-30 20:52:45 -0400
committerbnewbold <bnewbold@robocracy.org>2010-03-30 20:52:45 -0400
commite7d600494579ef319b20221769c3b2fe12962243 (patch)
tree5c95101e295bcfdd7f9f4292ce9204ddf7e7f662 /README
parent8d6bf3b196c2a0bc1adda4a04669e54fdc5b65cb (diff)
downloadlibrambutan-e7d600494579ef319b20221769c3b2fe12962243.tar.gz
librambutan-e7d600494579ef319b20221769c3b2fe12962243.zip
Major hierarchy reorganization; see README.
copy-to-ide and Makefile updated to conform; .gitignore added; LICENSE added
Diffstat (limited to 'README')
-rw-r--r--README45
1 files changed, 44 insertions, 1 deletions
diff --git a/README b/README
index 9723e93..9ea9a23 100644
--- a/README
+++ b/README
@@ -1,6 +1,49 @@
+ _ _ _ _
+ | (_) |__ _ __ ___ __ _ _ __ | | ___
+ | | | '_ \| '_ ` _ \ / _` | '_ \| |/ _ \
+ | | | |_) | | | | | | (_| | |_) | | __/
+ |_|_|_.__/|_| |_| |_|\__,_| .__/|_|\___|
+ |_| by leaflabs!
+
+
+
+The latest version of this repository can be found at:
+http://github.com/leaflabs/libmaple
+
+libmaple Repo Layout
+------------------------------------------------------------------------------
+/LICENSE
+ Licensing and copyright information
+
+/main.cpp.example
+ main.cpp is required for a successful build but is non-existant by default;
+ use this file as a template for building your program. By default just
+ blinks an LED.
+
+/build/
+ Binary output
+
+/stm32conf/
+ Linker scripts
+
+/libmaple/
+ Lowest level definitions, routines, macros, and functions. This is the meat
+ of the library.
+
+/core/
+ Extra wrappers and functionality around the lower level code which is
+ useful for programming in the IDE.
+
+/exapmles/
+
+
+/stm32lib/
+ The "standard" library given away by STM; to be removed ASAP.
+
+
Instructions to Compile for ARM Targets
-----------------------------------------
+------------------------------------------------------------------------------
The Codesourcery g++ compiler for arm platforms is required. It is based on gcc
(they push changes into gcc a couple times a year), get the latest EABI version
from: