From f50cba0d131546c5381c7f4efc1d1a0d7e50a84d Mon Sep 17 00:00:00 2001 From: James Vickery Date: Mon, 12 Feb 2018 10:39:31 +0000 Subject: [PATCH] Updated docs: fixed typos etc --- docs/about/contributing.md | 6 ++++-- docs/about/sources.md | 2 +- docs/about/support.md | 2 +- docs/index.md | 1 + docs/methods/clockwise-anticlockwise.md | 8 ++++---- 5 files changed, 11 insertions(+), 8 deletions(-) diff --git a/docs/about/contributing.md b/docs/about/contributing.md index f5f55e8..82d21d9 100644 --- a/docs/about/contributing.md +++ b/docs/about/contributing.md @@ -12,13 +12,15 @@ Code should work with both Python 2 & 3, and be [PEP8](https://www.python.org/de ## GitHub -Feel free to clone: [https://github.com/jamesevickery/l293d](https://github.com/jamesevickery/l293d) +This project is hosted on GitHub, at [https://github.com/jamesevickery/l293d](https://github.com/jamesevickery/l293d). -You may also fork if you wish to make changes +Feel free to star/fork ## Contributors +- [@jamesevickery](https://github.com/jamesevickery) +- [@alxwrd](https://github.com/alxwrd) - [@the-zebulan](https://github.com/the-zebulan) - [@surajnarwade](https://github.com/surajnarwade) - [@vlvrd](https://github.com/vlvrd) diff --git a/docs/about/sources.md b/docs/about/sources.md index 26ac805..1f333f9 100644 --- a/docs/about/sources.md +++ b/docs/about/sources.md @@ -1,5 +1,5 @@ # Sources -- The l293d library is based on [this tutorial](https://business.tutsplus.com/tutorials/controlling-dc-motors-using-python-with-a-raspberry-pi--cms-20051) - The circuit diagrams in the README are from here. +- The l293d library was originally based on [this tutorial](https://business.tutsplus.com/tutorials/controlling-dc-motors-using-python-with-a-raspberry-pi--cms-20051) - The circuit diagrams in the docs are from here. - Some helpful information about the driver chip can be found [here](http://www.rakeshmondal.info/L293D-Motor-Driver). - You can buy L293D driver chips cheaply online - I bought a [pack of 5 on Amazon](https://www.amazon.co.uk/dp/B008KYMVVY) diff --git a/docs/about/support.md b/docs/about/support.md index 1a57f9b..7f74184 100644 --- a/docs/about/support.md +++ b/docs/about/support.md @@ -2,7 +2,7 @@ If you have any ideas that would make this library even more beautiful, please [submit an issue](https://github.com/jamesevickery/l293d/issues) - or if you're feeling particularly helpful then I would be delighted if you'd fork and submit a pull request! If you want to contribute but don't have an idea, the [issues page](https://github.com/jamesevickery/l293d/issues) is rarely empty and any help would be very much appreciated - especially if the issue is tagged as '[help wanted](https://github.com/jamesevickery/l293d/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22)'. -Feel free to contact me if you have any questions about use or development of `l293d`. Either [submit an issue](https://github.com/jamesevickery/l293d/issues), email me at [jamesevickery.dev@gmail.com](mailto:jamesevickery.dev@gmail.com?Subject=L293D) or tweet/DM me [on Twitter](https://twitter.com/jamesevickery). +Feel free to contact me if you have any questions about use or development of `l293d`. Either [submit an issue](https://github.com/jamesevickery/l293d/issues), email me at [dev@jamesvickery.net](mailto:dev@jamesvickery.net?Subject=L293D) or tweet/DM me [on Twitter](https://twitter.com/jamesevickery). If you'd like to support my open-source development while I'm a poor university student, feel free to buy me a coffee! diff --git a/docs/index.md b/docs/index.md index cbdd059..7dba111 100644 --- a/docs/index.md +++ b/docs/index.md @@ -2,6 +2,7 @@ *Python module to drive DC motors from a Raspberry Pi using the L293D chip* [![PyPI version](https://badge.fury.io/py/l293d.svg)](https://badge.fury.io/py/l293d) +[![Python versions](https://img.shields.io/pypi/pyversions/l293d.svg)](https://pypi.python.org/pypi/l293d) [![Build Status](https://travis-ci.org/jamesevickery/l293d.svg?branch=master)](https://travis-ci.org/jamesevickery/l293d) [![Documentation Status](https://readthedocs.org/projects/l293d/badge/?version=latest)](http://l293d.readthedocs.io/en/latest/?badge=latest) [![Requirements Status](https://requires.io/github/jamesevickery/l293d/requirements.svg?branch=master)](https://requires.io/github/jamesevickery/l293d/requirements/?branch=master) diff --git a/docs/methods/clockwise-anticlockwise.md b/docs/methods/clockwise-anticlockwise.md index b32498d..c52e230 100644 --- a/docs/methods/clockwise-anticlockwise.md +++ b/docs/methods/clockwise-anticlockwise.md @@ -31,7 +31,7 @@ the `wait` parameter can be used The `speed` parameter can be used to control how fast the motor spins using [PWM (Pulse Width Modulation)](https://en.wikipedia.org/wiki/Pulse-width_modulation). -`speed` can be either a tuple or an iteger. When using a tuple, order matters +`speed` can be either a tuple or an integer. When using a tuple, order matters and it should be `(frequency, duty_cycle)`. There is also the option to be explict and use the `l293d.PWM` namedtuple which @@ -71,16 +71,16 @@ motor = l293d.DC(15, 18, 11) ``` -1. `motor.clockwise()` +- `motor.clockwise()` Turns `motor` on in the clockwise direction. Doesn't stop until `motor.stop()` is called -2. `motor.anticlockwise(3.5)` +- `motor.anticlockwise(3.5)` As `duration` is the first parameter of the `anticlockwise` and `clockwise` methods, the line above would make `motor` spin for 3.5 seconds before the method returns -3. `motor.clockwise(7, wait=False)` +- `motor.clockwise(7, wait=False)` `motor` spins for 7 seconds, but the method returns immediately. This means that any code following this line won't be delayed.