Skip to content

Commit b0b0027

Browse files
committed
latest concept
1 parent 34e9918 commit b0b0027

File tree

2 files changed

+29
-14
lines changed

2 files changed

+29
-14
lines changed

README.md

Lines changed: 29 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
![Qwiic SerLCD Python Module](docs/images/gh-banner-py-qwiic-serlcd.png "qwiic SerLCD Python Module" )
1+
![Qwiic SerLCD Python Package](docs/images/gh-banner-py-qwiic-serlcd.png "qwiic SerLCD Python Package" )
22

3-
# SparkFun Qwiic SerLCD - Python Module
3+
# SparkFun Qwiic SerLCD - Python Package
44

55
![PyPi Version](https://img.shields.io/pypi/v/sparkfun_qwiic_serlcd)
66
![GitHub issues](https://img.shields.io/github/issues/sparkfun/Qwiic_SerLCD_Py)
@@ -9,26 +9,26 @@
99

1010
The line of SparkFun Qwiic SerLCD products provide a simple and cost effective solution for adding a "text based" LCD display to your project. Implementing a SparkFun Qwiic interface, a SerLCD is rapidly added to any board that is part of the SparkFun Qwiic ecosystem.
1111

12-
This repository implements a Python module for the SparkFun Qwiic SerLCD series of products. This module works with Python, MicroPython and CircuitPython.
12+
This repository implements a Python package for the SparkFun Qwiic SerLCD series of products. This package works with Python, MicroPython and CircuitPython.
1313

1414
### Contents
1515

16-
* [About](#about-the-module)
16+
* [About](#about-the-package)
1717
* [Getting Started](#getting-started)
1818
* [Installation](#installation)
1919
* [Supported Platforms](#supported-platforms)
2020
* [Documentation](https://docs.sparkfun.com/Qwiic_SerLCD_Py/)
2121
* [Examples](#examples)
2222

23-
## About the Module
23+
## About the Package
2424

25-
This python module enables the user to access all of the features of these LCD products via a single Qwiic cable. This includes writing text to the screen, adjusting backlight levels (color), customizing splash screen and much much more. They come pre-programmed with the fully open-sourced [OpenLCD firmware](https://github.com/sparkfun/OpenLCD). All of the capabilities of these LCD screens are each demonstrated in the included examples.
25+
This python package enables the user to access all of the features of these LCD products via a single Qwiic cable. This includes writing text to the screen, adjusting backlight levels (color), customizing splash screen and much much more. They come pre-programmed with the fully open-sourced [OpenLCD firmware](https://github.com/sparkfun/OpenLCD). All of the capabilities of these LCD screens are each demonstrated in the included examples.
2626

2727

2828
New to qwiic? Take a look at the entire [SparkFun qwiic ecosystem](https://www.sparkfun.com/qwiic).
2929
### Supported SparkFun Products
3030

31-
This Python module supports the following SparkFun qwiic products on Python, MicroPython and Circuit python.
31+
This Python package supports the following SparkFun qwiic products on Python, MicroPython and Circuit python.
3232

3333
* [SparkFun SerLCD 16x2 - RGB Backlight (QWIIC)](https://www.sparkfun.com/products/16396)
3434
* [SparkFun SerLCD 16x2 - RGB Text (QWIIC)](https://www.sparkfun.com/products/16397)
@@ -43,31 +43,42 @@ This Python module supports the following SparkFun qwiic products on Python, Mic
4343
|CircuitPython | Raspberry Pi - RP2, ESP32 | [SparkFun RP2040 Thing+](https://www.sparkfun.com/sparkfun-thing-plus-rp2040.html), [SparkFun RP2350 Thing+](https://www.sparkfun.com/sparkfun-thing-plus-rp2350.html), [SparkFun ESP32 Thing+](https://www.sparkfun.com/sparkfun-thing-plus-esp32-wroom-usb-c.html)
4444

4545
> [!NOTE]
46-
> The listed supported platforms and boards are the primary platform targets tested. It is fully expected that this module will work across a wide variety of Python enabled systems.
46+
> The listed supported platforms and boards are the primary platform targets tested. It is fully expected that this package will work across a wide variety of Python enabled systems.
4747
4848

4949
---
5050
---
5151
---
5252
## Getting Started
5353

54-
### Installation
5554

5655

57-
### PyPi Installation
58-
This repository is hosted on PyPi as the [sparkfun-qwiic-serlcd](https://pypi.org/project/sparkfun-qwiic-serlcd/) package. On systems that support PyPi installation via pip, this library is installed using the following commands
56+
## Installation
57+
58+
The first step to using this package is installing it on your system. The install method depends on the python platform. The following sections outline installation on Python, MicroPython and CircuitPython.
59+
60+
### Python
61+
62+
The package is primarily installed using the `pip` command, downloading the package from the Python Index - "PyPi". Note - the below instructions outline installation an Linux-based (Raspberry Pi) system.
63+
64+
#### PyPi Installation
65+
66+
The SparkFun Qwiic SerLCD Python package is part of the overall SparkFun Qwiic Python package which is hosted on PyPi. On systems that support PyPi installation via pip, this library is installed using the following commands
5967

6068
For all users (note: the user must have sudo privileges):
6169
```sh
62-
sudo pip install sparkfun-qwiic-serlcd
70+
sudo pip install sparkfun-qwiic
6371
```
6472
For the current user:
6573

6674
```sh
67-
pip install sparkfun-qwiic-serlcd
75+
pip install sparkfun-qwiic
6876
```
6977

70-
### Local Installation
78+
> [!CAUTION]
79+
> **TODO** Put together how this works with the new virtual environments used with the latest Python install
80+
81+
#### Local Installation
7182
To install, make sure the setuptools package is installed on the system.
7283

7384
Direct installation at the command line:
@@ -85,6 +96,10 @@ cd dist
8596
pip install sparkfun_qwiic_serlcd-<version>.tar.gz
8697
```
8798

99+
### MicroPython
100+
101+
### CircuitPython
102+
88103
## Examples
89104

90105

509 Bytes
Loading

0 commit comments

Comments
 (0)