aboutsummaryrefslogtreecommitdiffstats
path: root/source
diff options
context:
space:
mode:
authorMarti Bolivar <mbolivar@leaflabs.com>2011-06-03 15:42:29 -0400
committerMarti Bolivar <mbolivar@leaflabs.com>2011-06-03 15:42:29 -0400
commitd53081c1bf6a4fdfcc248e164d9db078605ffd09 (patch)
treee78eee7f8a2baee2d272ac9fea4cec137e487ead /source
parent2f92b5e2c66f5422eca76882a3e23d498e7c618d (diff)
downloadlibrambutan-d53081c1bf6a4fdfcc248e164d9db078605ffd09.tar.gz
librambutan-d53081c1bf6a4fdfcc248e164d9db078605ffd09.zip
Docs: Various tweaks and fixups.
Thanks to forum user AndyH for the corrections.
Diffstat (limited to 'source')
-rw-r--r--source/maple-ide-install.rst7
-rw-r--r--source/maple-quickstart.rst12
-rw-r--r--source/unix-toolchain.rst10
3 files changed, 15 insertions, 14 deletions
diff --git a/source/maple-ide-install.rst b/source/maple-ide-install.rst
index bc8bc18..d3079c4 100644
--- a/source/maple-ide-install.rst
+++ b/source/maple-ide-install.rst
@@ -137,10 +137,11 @@ Make sure you have a Java runtime (JRE) installed; if you can run
:command:`java` from the shell, you should be fine.
Next, run the script :file:`install-udev-rules.sh` in the extracted
-IDE directory. It will ask for root permissions. You now need to
-restart udev::
+IDE directory. It will ask for root permissions (you will be prompted
+with something along the lines of ``[sudo] password for
+<username>:``). You now need to restart udev::
- sudo /etc/init.d/udev restart
+ $ sudo restart udev
This will grant members of the group ``plugdev`` read/write access to
Maple devices over USB. Make sure that you are in that group. (For
diff --git a/source/maple-quickstart.rst b/source/maple-quickstart.rst
index c7596ce..38b7fff 100644
--- a/source/maple-quickstart.rst
+++ b/source/maple-quickstart.rst
@@ -178,12 +178,12 @@ select Examples > Stubs > HelloWorld (similarly to when you selected
the Blink program), and make sure the correct board and serial port
targets are selected from the Tools menu.
-Open the Serial Monitor window (on the far right of the toolbar) and
-make sure the 9600 baud speed is selected. Then go back to the code
-editing window and upload your program (Upload will recompile your
-code automatically if there's been any change since the last
-Verify). You should get text spit at you over the serial monitor right
-after the program is uploaded. Shout back! We can hear you!
+Open the Serial Monitor window (on the far right of the toolbar). Then
+go back to the code editing window and upload your program (Upload
+will recompile your code automatically if there's been any change
+since the last Verify). You should get text spit at you over the
+serial monitor right after the program is uploaded. Shout back! We
+can hear you!
Go forth exuberantly!
---------------------
diff --git a/source/unix-toolchain.rst b/source/unix-toolchain.rst
index fddb529..1084ecc 100644
--- a/source/unix-toolchain.rst
+++ b/source/unix-toolchain.rst
@@ -65,7 +65,7 @@ your system down too much.
`Git <http://git-scm.com/>`_ is a distributed code versioning system
we use to track changes in our source code; ``git-core`` is the
-corresponding package.
+corresponding package.
``wget`` is a simple tool to download files over http from the command
line; installing it is optional (you could pull in the required
@@ -123,7 +123,7 @@ From the libmaple directory, ::
$ groups # make sure it includes plugdev; if not add, yourself to it
$ sudo cp support/scripts/45-maple.rules /etc/udev/rules.d/45-maple.rules
- $ sudo /etc/init.d/udev restart
+ $ sudo restart udev
As a security precaution on Linux, unknown USB devices can only be
accessed by root. This udev script identifies the Maple based on its
@@ -356,7 +356,7 @@ To exit the screen session, type :kbd:`C-a C-\\` (control-a, followed
by control-backslash) on Mac, or :kbd:`C-a k` (control-a k) on Linux,
and type ``y`` when prompted if you're sure.
-.. note::
+.. note::
Using ``screen`` sometimes messes up your terminal session on OS X.
If your shell starts acting funny after you exit ``screen``, you
@@ -373,7 +373,7 @@ Starting your own projects
--------------------------
So everything worked, and you want to start your own project? Great!
-There are two ways to go about it.
+There are two ways to go about it.
If your project is small, all you have to do is replace
:file:`~/libmaple/main.cpp` with your own code, and you're free to use
@@ -393,7 +393,7 @@ To create an archive, use the ``library`` Makefile target::
This will produce a build-time library in the file
:file:`~/libmaple/build/libmaple.a`. To use it, make sure that you
link against that library, and that the libmaple sources are in your
-include path.
+include path.
At a minimum, your include path should contain the directories
:file:`~/libmaple/libmaple` and :file:`~/libmaple/wirish/`. If you