Skip to content

Commit 2ea01f8

Browse files
authored
Merge pull request #9 from fourstix/b_fix_typo
Fixed formatting and small typos in Readme
2 parents 94561bb + 4c974d0 commit 2ea01f8

File tree

1 file changed

+11
-12
lines changed

1 file changed

+11
-12
lines changed

README.rst

Lines changed: 11 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -94,13 +94,13 @@ To install for current user:
9494

9595
.. code-block:: shell
9696
97-
pip3 install Sparkfun-circuitpython-qwiicjoystick
97+
pip3 install sparkfun-circuitpython-qwiicjoystick
9898
9999
To install system-wide (this may be required in some cases):
100100

101101
.. code-block:: shell
102102
103-
sudo pip3 install Sparkfun-circuitpython-qwiicjoystick
103+
sudo pip3 install sparkfun-circuitpython-qwiicjoystick
104104
105105
To install in a virtual environment in your current project:
106106

@@ -109,7 +109,7 @@ To install in a virtual environment in your current project:
109109
mkdir project-name && cd project-name
110110
python3 -m venv .env
111111
source .env/bin/activate
112-
pip3 install Sparkfun-circuitpython-qwiicjoystick
112+
pip3 install sparkfun-circuitpython-qwiicjoystick
113113
114114
115115
@@ -144,19 +144,18 @@ Usage Example
144144

145145
* Code Example:
146146

147-
.. code-block:: shell
147+
.. code-block:: shell
148148
149-
# import the CircuitPython board and busio libraries
150-
import board
151-
import busio
149+
# import the CircuitPython board and busio libraries
150+
import board
152151
153-
# Create bus object using the board's I2C port
154-
i2c = busio.I2C(board.SCL, board.SDA)
152+
# Create bus object using the board's I2C port
153+
i2c = board.I2C()
155154
156-
joystick = QwiicJoystick(i2c) # default address is 0x20
155+
joystick = QwiicJoystick(i2c) # default address is 0x20
157156
158-
# use QwiicJoystick(i2c, address) for a different address
159-
# joystick = QwiicJoystick(i2c, 0x21)"""
157+
# use QwiicJoystick(i2c, address) for a different address
158+
# joystick = QwiicJoystick(i2c, 0x21)"""
160159
161160
Contributing
162161
============

0 commit comments

Comments
 (0)