aboutsummaryrefslogtreecommitdiffstats
path: root/docs/source/unix-toolchain.rst
diff options
context:
space:
mode:
authorMarti Bolivar <mbolivar@leaflabs.com>2011-04-25 16:07:38 -0400
committerMarti Bolivar <mbolivar@leaflabs.com>2011-04-25 16:07:38 -0400
commitd6bb86b9e458bbf4f5a376caf05b2bc796a53aea (patch)
treeea01275fd4b3f48fb627abd2be5c1611047bdb58 /docs/source/unix-toolchain.rst
parentd64c13caf100c7fa638596bd568cce3ce2ffce0a (diff)
downloadlibrambutan-d6bb86b9e458bbf4f5a376caf05b2bc796a53aea.tar.gz
librambutan-d6bb86b9e458bbf4f5a376caf05b2bc796a53aea.zip
0.0.10 documentation checkpoint.
Merging in the standalone refactor docs, etc. The individual libmaple API pages are going to need to get redone.
Diffstat (limited to 'docs/source/unix-toolchain.rst')
-rw-r--r--docs/source/unix-toolchain.rst22
1 files changed, 12 insertions, 10 deletions
diff --git a/docs/source/unix-toolchain.rst b/docs/source/unix-toolchain.rst
index a173146..8b81e75 100644
--- a/docs/source/unix-toolchain.rst
+++ b/docs/source/unix-toolchain.rst
@@ -9,7 +9,9 @@
This is a tutorial for using the Maple with a standard Unix toolchain
(``make``, ``gcc``, etc.). It's not necessary to do this in order to
program the Maple; you can always :ref:`install the Maple IDE
-<maple-ide-install>` instead.
+<maple-ide-install>` instead. This document is intended for users who
+are comfortable using C or C++ and would like to use :ref:`libmaple`
+directly.
You'll need a Maple board, a Mini-B USB cable, a functional computer,
and root (or Administrator) access to that computer. This guide
@@ -100,7 +102,7 @@ in `Python <http://python.org>`_, and requires the `PySerial
$ export PATH=$PATH:~/libmaple/arm/bin # or wherever these tools ended up
This step is fairly straightforward: do a git clone of the `libmaple
-repository <http://github.com/leaflabs/libmaple>`_ to some directory,
+repository <https://github.com/leaflabs/libmaple>`_ to some directory,
then download and extract the ARM compiler toolchain.
The :file:`arm/bin/` directory will need to be added to ``PATH``; you
@@ -169,9 +171,9 @@ You will need the following tools\ [#fpackman]_ to get started:
<http://wiki.openmoko.org/wiki/Dfu-util#Mac>`_.
If you're in a hurry, you can steal a dfu-util binary from a program
- called `Openmoko Flasher
- <http://www.handheld-linux.com/wiki.php?page=Openmoko%20Flasher>`_. To
- do this, first `download Openmoko Flasher
+ called `OpenMoko Flasher
+ <http://www.handheld-linux.com/wiki.php?page=OpenMoko%20Flasher>`_. To
+ do this, first `download OpenMoko Flasher
<http://projects.goldelico.com/p/omflasher/downloads/>`_, then copy
the OpenMoko application into your :file:`/Applications` folder (or
wherever you like). Let's pretend you saved the .app to the directory
@@ -292,11 +294,11 @@ If it all works out, you should end up seeing something like this::
21824 200 552 22576 5830 build/maple.out
Flash build
-Woo! It worked. The ``dec`` field at the end gives the total program
-size in bytes. The long listing of object files above the ``Final
-Size`` helps to identify bloated code. As you write larger projects,
-you may find that they use too much space. If that happens, the
-file-by-file listing will help you track down the culprits.
+The ``dec`` field at the end gives the total program size in
+bytes. The long listing of object files above the ``Final Size`` helps
+to identify bloated code. As you write larger projects, you may find
+that they use too much space. If that happens, the file-by-file
+listing will help you track down the culprits.
.. _toolchain-upload: