Skip to content

Commit 2f740e5

Browse files
authored
Handle README TODOs
I didn't actually add a link to one of them because I am not prepared to choose appropriate link targets, but I did add a link to new ev3dev.org content. Also fixed some bad formatting.
1 parent eca9cdb commit 2f740e5

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

README.rst

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,23 +12,23 @@ letting you control motors, sensors, hardware buttons, LCD
1212
displays and more from Python code.
1313

1414
If you haven't written code in Python before, you'll need to learn the language
15-
before you can use this library. **TODO: INSERT RESOURCES HERE**
15+
before you can use this library.
1616

1717
Getting Started
1818
---------------
1919

2020
This library runs on ev3dev_. Before continuing, make sure that you have set up
2121
your EV3 or other ev3dev device as explained in the `ev3dev Getting Started guide`_.
22-
Make sure that you have a kernel version that includes `-10-ev3dev` or higher (a
22+
Make sure that you have a kernel version that includes ``-10-ev3dev`` or higher (a
2323
larger number). You can check the kernel version by selecting "About" in Brickman
2424
and scrolling down to the "kernel version". If you don't have a compatible version,
25-
upgrade the kernel first. **TODO: INSERT LINK HERE**
25+
`upgrade the kernel before continuing`_.
2626

2727
Once you have booted ev3dev and connected to your EV3 (or Raspberry Pi / BeagleBone)
2828
via SSH, you will need to install the latest version of this library.
2929

3030
To do so, run the following commands, which could take ten minutes or longer
31-
(you may be prompted to type the password; the default is `maker`):
31+
(you may be prompted to type the password; the default is ``maker``):
3232

3333
.. code-block:: bash
3434
@@ -48,7 +48,7 @@ Usage Examples
4848
------------
4949

5050
To run these minimal examples, run the Python3 interpreter from
51-
the terminal using the `python3` command:
51+
the terminal using the ``python3`` command:
5252

5353
.. code-block::
5454
@@ -194,6 +194,7 @@ sure that you have installed the newest version of the Python 3-based library.
194194
.. _Getting Started: ev3dev-getting-started_
195195
.. _ev3dev Getting Started guide: ev3dev-getting-started_
196196
.. _ev3dev-getting-started: http://www.ev3dev.org/docs/getting-started/
197+
.. _upgrade the kernel before continuing: http://www.ev3dev.org/docs/tutorials/upgrading-ev3dev/
197198
.. _detailed instructions for USB connections: ev3dev-usb-internet_
198199
.. _ev3dev-usb-internet: http://www.ev3dev.org/docs/tutorials/connecting-to-the-internet-via-usb/
199200
.. _our Read the Docs page: http://python-ev3dev.readthedocs.org/en/latest/

0 commit comments

Comments
 (0)