Skip to content

Commit 5f6cdf5

Browse files
committed
trail/prototype of new banner for the readme /documentation
1 parent 73badb5 commit 5f6cdf5

File tree

2 files changed

+23
-33
lines changed

2 files changed

+23
-33
lines changed

README.md

Lines changed: 23 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,28 @@
1-
Qwiic_SerLCD_Py
2-
==============
31

4-
<p align="center">
5-
<img src="https://cdn.sparkfun.com/assets/custom_pages/2/7/2/qwiic-logo-registered.jpg" width=200>
6-
<img src="https://www.python.org/static/community_logos/python-logo-master-v3-TM.png" width=240>
7-
</p>
8-
<p align="center">
9-
<a href="https://pypi.org/project/sparkfun-qwiic-serlcd/" alt="Package">
10-
<img src="https://img.shields.io/pypi/pyversions/sparkfun_qwiic_serlcd.svg" /></a>
11-
<a href="https://github.com/sparkfun/Qwiic_SerLCD_Py/issues" alt="Issues">
12-
<img src="https://img.shields.io/github/issues/sparkfun/Qwiic_SerLCD_Py.svg" /></a>
13-
<a href="https://qwiic-serlcd-py.readthedocs.io/en/latest/" alt="Documentation">
14-
<img src="https://readthedocs.org/projects/qwiic-serlcd-py/badge/?version=latest&style=flat" /></a>
15-
<a href="https://github.com/sparkfun/Qwiic_SerLCD_Py/blob/master/LICENSE" alt="License">
16-
<img src="https://img.shields.io/badge/license-MIT-blue.svg" /></a>
17-
<a href="https://twitter.com/intent/follow?screen_name=sparkfun">
18-
<img src="https://img.shields.io/twitter/follow/sparkfun.svg?style=social&logo=twitter"
19-
alt="follow on Twitter"></a>
20-
</p>
2+
![Qwiic SerLCD Python Module](docs/images/gh-banner-py-qwiic-serlcd.png "qwiic SerLCD Python Module" )
3+
4+
# SparkFun Qwiic SerLCD Python Module
5+
6+
A Python module for the SparkFun Qwiic SerLCD series of products. This module works with Python, MicroPython and CircuitPython.
7+
8+
9+
![Python Versions](https://img.shields.io/pypi/pyversions/sparkfun_qwiic_serlcd)
10+
![GitHub issues](https://img.shields.io/github/issues/sparkfun/Qwiic_SerLCD_Py)
11+
![License](https://img.shields.io/github/license/sparkfun/Qwiic_SerLCD_Py)
12+
![X](https://img.shields.io/twitter/follow/sparkfun
13+
)
14+
15+
## Supported SparkFun Products
16+
17+
This Python module supports the following SparkFun qwiic products on Python, MicroPython and Circuit python.
18+
19+
* [SparkFun SerLCD 16x2 - RGB Backlight (QWIIC)](https://www.sparkfun.com/products/16396)
20+
* [SparkFun SerLCD 16x2 - RGB Text (QWIIC)](https://www.sparkfun.com/products/16397)
21+
* [SparkFun SerLCD 20x2 - RGB Backlight (QWIIC)](https://www.sparkfun.com/products/16398)
22+
23+
## Overview
2124

22-
<table class="table table-hover table-striped table-bordered">
23-
<tr align="center">
24-
<td><a href="https://www.sparkfun.com/products/16396"><img src="https://cdn.sparkfun.com//assets/parts/1/5/1/2/2/16396-SparkFun_16x2_SerLCD_-_RGB_Backlight__Qwiic_-05.jpg" title="SparkFun SerLCD 16x2 - RGB Backlight (QWIIC)"></a></td>
25-
<td><a href="https://www.sparkfun.com/products/16397"><img src="https://cdn.sparkfun.com//assets/parts/1/5/1/2/3/16397-SparkFun_16x2_SerLCD_-_RGB_Backlight__Qwiic_-05.jpg" title="SparkFun SerLCD 16x2 - RGB Text (QWIIC)"></a></td>
26-
<td><a href="https://www.sparkfun.com/products/16398"><img src="https://cdn.sparkfun.com//assets/parts/1/5/1/2/4/16398-SparkFun_16x2_SerLCD_-_RGB_Backlight__Qwiic_-05.jpg" title="SparkFun SerLCD 20x2 - RGB Backlight (QWIIC)"></a></td>
27-
</tr>
28-
<tr align="center">
29-
<td><i><a href="https://www.sparkfun.com/products/16396">SparkFun SerLCD 16x2 - RGB Backlight (QWIIC)</a></i></td>
30-
<td><i><a href="https://www.sparkfun.com/products/16397">SparkFun SerLCD 16x2 - RGB Text (QWIIC)</a></i></td>
31-
<td><i><a href="https://www.sparkfun.com/products/16398">SparkFun SerLCD 20x2 - RGB Backlight (QWIIC)</a></i></td>
32-
</tr>
33-
</table>
34-
35-
Python module for I2C control of the SparkFun Qwiic Serial LCDs.
25+
This Python module implements support for I2C control of the SparkFun Qwiic Serial LCDs. It supports Python, MicroPython and CircuitPython environments.
3626

3727
This 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 17 examples.
3828

554 KB
Loading

0 commit comments

Comments
 (0)