Skip to content

Commit b4abdb2

Browse files
author
Brian Hines
committed
Minor text edits
1 parent e1a418e commit b4abdb2

1 file changed

Lines changed: 6 additions & 6 deletions

File tree

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
11
Boilerplate code is annoying and sometimes there can be a lot of it working with [Raspberry Pi GPIO](https://pypi.python.org/pypi/RPi.GPIO). I got tired of setting the board mode and declaring GPIO channels in every script so I made a library that uses a config file instead. In addition to getting rid of the boilerplate, **Pi-Pin-Manager** has the added benefit of pulling the configuration out of the code. This means you can modify any pin's behavior without ever touching a Python file or having to redeploy your program.
22

33

4-
### Install It
4+
### Install it
55

66
```
77
pip install Pi-Pin-Manager
88
```
99

10-
### Configure It
10+
### Configure it
1111

1212
When creating an instance of `pi_pin_manager.PinManager`, there are two ways you can supply pin configuration information: A config file, written in [YAML](http://en.wikipedia.org/wiki/YAML) or a dictionary. If a pin is not defined at this step it will not be available to the `PinManager`.
1313

14-
#### Configure with file
14+
#### With file
1515

1616
The following snippet shows an example configuration file:
1717

@@ -29,7 +29,7 @@ The following snippet shows an example configuration file:
2929
bounce: 200
3030
```
3131
32-
#### Configure with dictionary
32+
#### With dictionary
3333
3434
This snippet shows the same configuration example above as a dictionary:
3535
@@ -62,7 +62,7 @@ config = {
6262
For full documentation about available GPIO input pin configurations see the [documentation](http://sourceforge.net/p/raspberry-gpio-python/wiki/Examples/).
6363

6464

65-
### Use It (No Event)
65+
### Use it (no event)
6666

6767
```python
6868
from pi_pin_manager import PinManager
@@ -96,7 +96,7 @@ pins.cleanup(18)
9696
pins.cleanup()
9797
```
9898

99-
### Use It (With Event)
99+
### Use it (with event)
100100

101101
If an `event` and `handler` have been defined for a pin in the config file, then you must also provide a class that contains the callbacks to execute. Each method you add to this class should match the name of a `handler` value. Based on the example code below, `handler: do_something` is expected in the config file `path/to/config/file.yml`.
102102

0 commit comments

Comments
 (0)