Skip to content

Commit d5ac633

Browse files
WasabiFanddemidov
authored andcommitted
Fix small errors in README and add explanation (#231)
1 parent e6a1dde commit d5ac633

File tree

1 file changed

+21
-13
lines changed

1 file changed

+21
-13
lines changed

README.rst

Lines changed: 21 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -79,14 +79,19 @@ Running a motor
7979
~~~~~~~~~~~~~~~
8080

8181
Now plug a motor into the ``A`` port and paste this code into the Python prompt.
82-
This little program will run the motor at 500 ticks per second (around 0.4
83-
rotations per second) for three seconds.
82+
This little program will run the motor at 500 ticks per second, which on the EV3
83+
"large" motors equates to around 1.4 rotations per second, for three seconds
84+
(3000 milliseconds).
8485

8586
.. code-block:: python
8687
8788
m = ev3.LargeMotor('outA')
8889
m.run_timed(time_sp=3000, speed_sp=500)
8990
91+
The units for ``speed_sp`` that you see above are in "tacho ticks" per second.
92+
On the large EV3 motor, these equate to one tick per degree, so this is 500
93+
degress per second.
94+
9095
Using text-to-speech
9196
~~~~~~~~~~~~~~~~~~~~
9297

@@ -128,9 +133,15 @@ Library Documentation
128133
You can always go there to get information on how you can use this
129134
library's functionality.
130135

136+
ev3python.com
137+
One of our community members, @ndward, has put together a great website
138+
with detailed guides on using this library which are targeted at beginners.
139+
If you are just getting started with programming, we highly recommend
140+
that you check it out at `ev3python.com`!
141+
131142
ev3dev.org
132-
`ev3dev.org`_ is a great resource for finding guides and tutoials on
133-
using ev3dev.
143+
`ev3dev.org`_ is a great resource for finding guides and tutorials on
144+
using ev3dev, straight from the maintainers.
134145

135146
Support
136147
If you are having trouble using this library, please open an issue
@@ -180,18 +191,14 @@ The ev3dev-lang Project on GitHub
180191
generate the binding. Only developers of the ev3dev-lang-python_ binding
181192
would normally need to access this information.
182193

183-
Python2.x and Python3.x Compatibility
194+
Python 2.x and Python 3.x Compatibility
184195
-------------------------------------
185196

186-
The ev3dev_ distribution comes with both python2_ and python3_ installed
187-
but this library is compatible only with Python3.
188-
189-
Note that currently, the Python3 binding for ev3dev_ is not installed
190-
by default - this will be addressed in the next package we
191-
release.
197+
Some versions of the ev3dev_ distribution come with both `Python 2.x`_ and `Python 3.x`_ installed
198+
but this library is compatible only with Python 3.
192199

193-
Until then, you must follow the instructions at the top of this README to make
194-
sure that you have installed the newest version of the Python 3-based library.
200+
As of the 2016-10-17 ev3dev image, the version of this library which is included runs on
201+
Python 3 and this is the only version that will be supported from here forward.
195202

196203
.. _ev3dev: http://ev3dev.org
197204
.. _ev3dev.org: ev3dev_
@@ -204,6 +211,7 @@ sure that you have installed the newest version of the Python 3-based library.
204211
.. _ev3dev-usb-internet: http://www.ev3dev.org/docs/tutorials/connecting-to-the-internet-via-usb/
205212
.. _our Read the Docs page: http://python-ev3dev.readthedocs.org/en/latest/
206213
.. _source repository for the generic API: ev3dev-lang_
214+
.. _ev3python.com: http://ev3python.com/
207215
.. _ev3dev-lang: https://github.com/ev3dev/ev3dev-lang
208216
.. _ev3dev-lang-python: https://github.com/rhempel/ev3dev-lang-python
209217
.. _our Issues tracker: https://github.com/rhempel/ev3dev-lang-python/issues

0 commit comments

Comments
 (0)