Skip to content

Commit e5dd64e

Browse files
Update readme
1 parent 9345745 commit e5dd64e

File tree

1 file changed

+27
-5
lines changed

1 file changed

+27
-5
lines changed

README.md

Lines changed: 27 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -56,8 +56,6 @@ The package is primarily installed using the `pip3` command, downloading the pac
5656

5757
#### PyPi Installation
5858

59-
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.
60-
6159
First, setup a virtual environment from a specific directory using venv:
6260
```sh
6361
python3 -m venv path/to/venv
@@ -66,11 +64,11 @@ You can pass any path as path/to/venv, just make sure you use the same one for a
6664

6765
Next, install the qwiic package with:
6866
```sh
69-
path/to/venv/pip3 install sparkfun-qwiic-serlcd
67+
path/to/venv/bin/pip3 install sparkfun-qwiic-serlcd
7068
```
7169
Now you should be able to run any example or custom python scripts that have `import qwiic_serlcd` by running e.g.:
7270
```sh
73-
path/to/venv/python3 example_script.py
71+
path/to/venv/bin/python3 example_script.py
7472
```
7573

7674
#### MicroPython Installation
@@ -81,6 +79,11 @@ Connect a device with MicroPython installed to your computer and then install th
8179
mpremote mip install github:sparkfun/qwiic_serlcd_py
8280
```
8381

82+
If you would also like to install the examples for this repository, issue the following mip command as well:
83+
```sh
84+
mprmeote mip install github:sparkfun/qwiic_serlcd_py@examples
85+
```
86+
8487
#### CircuitPython Installation
8588
If not already installed, follow the [instructions here](https://docs.circuitpython.org/projects/circup/en/latest/#installation) to install CircUp on your computer.
8689

@@ -94,7 +97,26 @@ Finally, connect a device with CircuitPython installed to your computer and then
9497
circup install --py qwiic_serlcd
9598
```
9699

97-
## Getting Started
100+
If you would like to install any of the examples from this repository, issue the corresponding circup command from below. (NOTE: The below syntax assumes you are using CircUP on Windows. Linux and Mac will have different path seperators (i.e. "/" vs. "\"). See the [CircUp "example" command documentation](https://learn.adafruit.com/keep-your-circuitpython-libraries-on-devices-up-to-date-with-circup/example-command) for more information)
101+
```sh
102+
circup example qwiic_serlcd\ex1_qwiic_serlcd_hello_world
103+
circup example qwiic_serlcd\ex2_qwiic_serlcd_backlight
104+
circup example qwiic_serlcd\ex3_qwiic_serlcd_set_cursor_position
105+
circup example qwiic_serlcd\ex4_qwiic_serlcd_move_cursor
106+
circup example qwiic_serlcd\ex5_qwiic_serlcd_enable_cursor
107+
circup example qwiic_serlcd\ex6_qwiic_serlcd_blink_cursor
108+
circup example qwiic_serlcd\ex7_qwiic_serlcd_scroll
109+
circup example qwiic_serlcd\ex8_qwiic_serlcd_autoscroll_with_text
110+
circup example qwiic_serlcd\ex9_qwiic_serlcd_custom_character
111+
circup example qwiic_serlcd\ex10_qwiic_serlcd_turn_off_display
112+
circup example qwiic_serlcd\ex11_qwiic_serlcd_text_direction
113+
circup example qwiic_serlcd\ex12_qwiic_serlcd_console_input_to_display
114+
circup example qwiic_serlcd\ex13_qwiic_serlcd_fast_backlight
115+
circup example qwiic_serlcd\ex14_qwiic_serlcd_show_firmware_version
116+
circup example qwiic_serlcd\ex15_qwiic_serlcd_message_enable
117+
circup example qwiic_serlcd\ex16_qwiic_serlcd_set_splash
118+
circup example qwiic_serlcd\ex17_qwiic_serlcd_change_i2c_address.py
119+
```
98120

99121
## Examples
100122
Below is a quickstart program to print "Hello World!" to the Serial LCD.

0 commit comments

Comments
 (0)