Skip to content

Fixed formatting and small typos in Readme #9

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 14, 2021
Merged

Fixed formatting and small typos in Readme #9

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 11 additions & 12 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,13 +94,13 @@ To install for current user:

.. code-block:: shell

pip3 install Sparkfun-circuitpython-qwiicjoystick
pip3 install sparkfun-circuitpython-qwiicjoystick

To install system-wide (this may be required in some cases):

.. code-block:: shell

sudo pip3 install Sparkfun-circuitpython-qwiicjoystick
sudo pip3 install sparkfun-circuitpython-qwiicjoystick

To install in a virtual environment in your current project:

Expand All @@ -109,7 +109,7 @@ To install in a virtual environment in your current project:
mkdir project-name && cd project-name
python3 -m venv .env
source .env/bin/activate
pip3 install Sparkfun-circuitpython-qwiicjoystick
pip3 install sparkfun-circuitpython-qwiicjoystick



Expand Down Expand Up @@ -144,19 +144,18 @@ Usage Example

* Code Example:

.. code-block:: shell
.. code-block:: shell

# import the CircuitPython board and busio libraries
import board
import busio
# import the CircuitPython board and busio libraries
import board

# Create bus object using the board's I2C port
i2c = busio.I2C(board.SCL, board.SDA)
# Create bus object using the board's I2C port
i2c = board.I2C()

joystick = QwiicJoystick(i2c) # default address is 0x20
joystick = QwiicJoystick(i2c) # default address is 0x20

# use QwiicJoystick(i2c, address) for a different address
# joystick = QwiicJoystick(i2c, 0x21)"""
# use QwiicJoystick(i2c, address) for a different address
# joystick = QwiicJoystick(i2c, 0x21)"""

Contributing
============
Expand Down