aboutsummaryrefslogtreecommitdiffstats
path: root/docs/source/unix-toolchain.rst
diff options
context:
space:
mode:
authorMarti Bolivar <mbolivar@mit.edu>2010-11-29 01:49:26 -0500
committerMarti Bolivar <mbolivar@mit.edu>2010-11-29 01:49:26 -0500
commit078edc158da7906ba72e7e6528e1a811e07270e7 (patch)
tree1bc7b2e8137fb5ebfc7b59d59294d7adb9e95468 /docs/source/unix-toolchain.rst
parent5e587be27a7c3bd854b686952a5c9637a2432ff0 (diff)
downloadlibrambutan-078edc158da7906ba72e7e6528e1a811e07270e7.tar.gz
librambutan-078edc158da7906ba72e7e6528e1a811e07270e7.zip
Finished converting the Arduino docs
Diffstat (limited to 'docs/source/unix-toolchain.rst')
-rw-r--r--docs/source/unix-toolchain.rst31
1 files changed, 15 insertions, 16 deletions
diff --git a/docs/source/unix-toolchain.rst b/docs/source/unix-toolchain.rst
index 2bb584a..e6039a2 100644
--- a/docs/source/unix-toolchain.rst
+++ b/docs/source/unix-toolchain.rst
@@ -97,12 +97,12 @@ This step is fairly straightforward: do a git clone of the `libmaple
repository <http://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
-:envvar:`PATH`; you can check that this worked by entering
-``arm-none-`` and hitting tab to auto-complete (bash should show a
-bunch of results). Regardless of where you put the toolchain, make
-sure to preserve its internal directory layout, as the binaries make
-relative path calls and references.
+The :file:`arm/bin/` directory will need to be added to ``PATH``; you
+can check that this worked by entering ``arm-none-`` and hitting tab
+to auto-complete (bash should show a bunch of results). Regardless of
+where you put the toolchain, make sure to preserve its internal
+directory layout, as the binaries make relative path calls and
+references.
.. _toolchain-udev:
@@ -176,7 +176,7 @@ You will need the following tools to get started:
:file:`/Applications/OpenMoko Flasher.app/Contents/Mac OS/dfu-util`
To get access to it from the command line, just make a symbolic link
- to the binary from some place on your :envvar:`PATH`::
+ to the binary from some place on your ``PATH``::
$ ln -s /Applications/OpenMoko\ Flasher.app/Contents/Mac\ OS/dfu-util \
/somewhere/on/your/PATH/dfu-util
@@ -241,7 +241,7 @@ live with ::
$ export PATH=$PATH:~/libmaple/arm/bin
After that's done, you'll probably want to update your shell startup
-script so :file:`~/libmaple/arm/bin` stays in your :envvar:`PATH`.
+script so :file:`~/libmaple/arm/bin` stays in your ``PATH``.
**So far, so good?**
@@ -350,8 +350,8 @@ Starting your own projects
--------------------------
So everything worked, and you want to start your own project? Great!
-It's easy. Just set the environment variable :envvar:`LIB_MAPLE_HOME`
-in your shell startup script to point to the libmaple repository you
+It's easy. Just set the environment variable ``LIB_MAPLE_HOME`` in
+your shell startup script to point to the libmaple repository you
cloned (this tutorial assumes you put it in :file:`~/libmaple`). For
example, if you use bash as your shell, just put this line in your
:file:`~/.bashrc` or :file:`~/.bash_profile`::
@@ -417,10 +417,9 @@ but it might be helpful for people who are allergic to `vim
<http://www.gnu.org/software/emacs/>`_. The simple configuration
described here just calls down to the :file:`Makefile`, so follow the
above directions to get the command line tools configured (you'll
-definitely need the arm-none-eabi-* tools on your :envvar:`PATH`),
-then `install Code::Blocks
-<http://www.codeblocks.org/downloads/26>`_. You can do this on Linux
-with::
+definitely need the arm-none-eabi-* tools on your ``PATH``), then
+`install Code::Blocks <http://www.codeblocks.org/downloads/26>`_. You
+can do this on Linux with::
$ sudo aptitude install codeblocks
@@ -434,8 +433,8 @@ to get a feel for how it all works.
To create your own "libmaple" project, start with an "Empty Project"
with the "Folder to create project in" set to your
-:envvar:`LIB_MAPLE_HOME`. Make sure that the "Resulting filename" is
-in the top level directory as well.
+``LIB_MAPLE_HOME``. Make sure that the "Resulting filename" is in the
+top level directory as well.
.. image:: /_static/img/codeblocks_newproject.png
:align: center