Skip to content

Commit e683b0d

Browse files
Make changes to readme and pyproject.toml.
1 parent 7903435 commit e683b0d

File tree

2 files changed

+7
-7
lines changed

2 files changed

+7
-7
lines changed

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ New to qwiic? Take a look at the entire [SparkFun qwiic ecosystem](https://www.s
2222
* [Installation](#installation)
2323

2424
### Supported Platforms
25-
25+
See the [MicroPython Downloads Page](https://micropython.org/download/?vendor=Sparkfun) for more boards compatible with MicroPython.
2626
| Python | Platform | Boards |
2727
|--|--|--|
2828
| Python | Linux | [Raspberry Pi](https://www.sparkfun.com/raspberry-pi-5-8gb.html) , [NVIDIA Jetson Orin Nano](https://www.sparkfun.com/nvidia-jetson-orin-nano-developer-kit.html) via the [SparkFun Qwiic SHIM](https://www.sparkfun.com/sparkfun-qwiic-shim-for-raspberry-pi.html) |
@@ -55,17 +55,17 @@ Note - the below instructions outline installation on a Linux-based (Raspberry P
5555

5656
First, setup a virtual environment from a specific directory using venv:
5757
```sh
58-
python3 -m venv path/to/venv
58+
python3 -m venv ~/sparkfun_venv
5959
```
60-
You can pass any path as path/to/venv, just make sure you use the same one for all future steps. For more information on venv [click here](https://docs.python.org/3/library/venv.html).
60+
You can pass any path instead of ~/sparkfun_venv, just make sure you use the same one for all future steps. For more information on venv [click here](https://docs.python.org/3/library/venv.html).
6161

6262
Next, install the qwiic package with:
6363
```sh
64-
path/to/venv/bin/pip3 install sparkfun-qwiic-i2c
64+
~/sparkfun_venv/bin/pip3 install sparkfun-qwiic-i2c
6565
```
6666
Now you should be able to run any example or custom python scripts that have `import qwiic_i2c` by running e.g.:
6767
```sh
68-
path/to/venv/bin/python3 example_script.py
68+
~/sparkfun_venv/bin/python3 example_script.py
6969
```
7070

7171
### MicroPython Installation

pyproject.toml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,10 @@ requires = ["setuptools"]
44
[project]
55
name = "sparkfun_qwiic_i2c"
66
version = "1.0.0"
7-
description = "SparkFun Electronics qwiic I2C library"
7+
description = "SparkFun Electronics Qwiic I2C library"
88
readme = "DESCRIPTION.rst"
99

10-
authors = [{name="Sparkfun Electronics", email="info@sparkfun.com"}]
10+
authors = [{name="SparkFun Electronics", email="info@sparkfun.com"}]
1111
dependencies = ["smbus2"]
1212

1313
classifiers=[

0 commit comments

Comments
 (0)