Skip to content

Commit 05d3a7c

Browse files
authored
Update README for upcoming release (#221)
1 parent 135a868 commit 05d3a7c

File tree

1 file changed

+19
-14
lines changed

1 file changed

+19
-14
lines changed

README.rst

+19-14
Original file line numberDiff line numberDiff line change
@@ -22,21 +22,13 @@ your EV3 or other ev3dev device as explained in the `ev3dev Getting Started guid
2222
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 before continuing`_.
25+
`upgrade the kernel before continuing`_. Also note that if the ev3dev image you downloaded
26+
was created before September 2016, you probably don't have the most recent version of this
27+
library installed: see `Upgrading this Library`_ to upgrade it.
2628

27-
Once you have booted ev3dev and connected to your EV3 (or Raspberry Pi / BeagleBone)
28-
via SSH, you will need to install the latest version of this library.
29-
30-
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``):
32-
33-
.. code-block:: bash
34-
35-
sudo apt-get update
36-
sudo apt-get install python3-ev3dev
37-
38-
Now that you have the latest version installed, you should be ready to start
39-
using ev3dev with Python. If you want to go through some basic usage examples,
29+
Once you have booted ev3dev and `connected to your EV3 (or Raspberry Pi / BeagleBone)
30+
via SSH`_, you should be ready to start using ev3dev with Python: this library
31+
is included out-of-the-box. If you want to go through some basic usage examples,
4032
check out the `Usage Examples`_ section to try out motors, sensors and LEDs.
4133
Then look at `Writing Python Programs for Ev3dev`_ to see how you can save
4234
your Python code to a file.
@@ -158,6 +150,18 @@ Demo Code
158150
this language binding. The programs are designed to work with the
159151
`EXPLOR3R`_ robot.
160152

153+
Upgrading this Library
154+
----------------------
155+
156+
You can upgrade this library from the command line as follows. Make sure
157+
to type the password (the default is ``maker``) when prompted.
158+
159+
.. code-block:: bash
160+
161+
sudo apt-get update
162+
sudo apt-get install python3-ev3dev
163+
164+
161165
Developer Resources
162166
-------------------
163167

@@ -196,6 +200,7 @@ sure that you have installed the newest version of the Python 3-based library.
196200
.. _ev3dev-getting-started: http://www.ev3dev.org/docs/getting-started/
197201
.. _upgrade the kernel before continuing: http://www.ev3dev.org/docs/tutorials/upgrading-ev3dev/
198202
.. _detailed instructions for USB connections: ev3dev-usb-internet_
203+
.. _connected to your EV3 (or Raspberry Pi / BeagleBone) via SSH: http://www.ev3dev.org/docs/tutorials/connecting-to-ev3dev-with-ssh/
199204
.. _ev3dev-usb-internet: http://www.ev3dev.org/docs/tutorials/connecting-to-the-internet-via-usb/
200205
.. _our Read the Docs page: http://python-ev3dev.readthedocs.org/en/latest/
201206
.. _source repository for the generic API: ev3dev-lang_

0 commit comments

Comments
 (0)