Updating the samples README to reflect current contents

This commit is contained in:
Andy Piper 2022-04-23 21:47:09 +01:00
parent 7dd1c60861
commit 7c47b1c53f
No known key found for this signature in database
GPG Key ID: 8FBF7373AC449A7F
1 changed files with 14 additions and 4 deletions

View File

@ -14,6 +14,7 @@
- [Image](#image) - [Image](#image)
- [QR gen](#qr-gen) - [QR gen](#qr-gen)
- [Launcher](#launcher) - [Launcher](#launcher)
- [Conway](#conway)
## Function Examples ## Function Examples
@ -56,10 +57,12 @@ python3 convert.py --binary --resize image_file_1.png image_file_2.png image_fil
A checklist application, letting you navigate through items and tick each of them off. A checklist application, letting you navigate through items and tick each of them off.
* `checklist.txt` - A text file containing the titles of items for the list.
### Clock ### Clock
[clock.py](clock.py) [clock.py](clock.py)
A simple clock showing the time and date, that uses the E Ink's fast speed to update every second A simple clock showing the time and date, that uses the E Ink's fast speed to update every second.
### E-Book ### E-Book
[ebook.py](ebook.py) [ebook.py](ebook.py)
@ -83,10 +86,17 @@ python3 convert.py --binary --resize image_file_1.png image_file_2.png image_fil
### QR gen ### QR gen
[qrgen.py](qrgen.py) [qrgen.py](qrgen.py)
This application looks for a file on your MicroPython drive: Displays and lets you cycle through multiple QR codes, with configuration stored in text files within the MicroPython device's `/qrcodes` directory.
- `qrcode.txt` - A text file containing 9 lines. The first line should be a URL which will be converted into and displayed as a QR code. Up to 8 more lines of information can be added, which will be shown as plain text to the right of the QR code.
- `/qrcodes/qrcode.txt` - A text file containing 9 lines. The first line should be a URL which will be converted into and displayed as a QR code. Up to 8 more lines of information can be added, which will be shown as plain text to the right of the QR code.
- `/qrcodes/*.txt` - additional text files can be created using the same format. All text files can be cycled through.
### Launcher ### Launcher
[launcher.py](launcher.py) [launcher.py](launcher.py)
A launcher-style application, that provide a menu of other applications that can be loaded, as well as information such as battery level. A launcher-style application, providing a menu of other applications that can be loaded, as well as information such as battery level.
### Conway
[conway.py](conway.py)
Conway's classic Game of Life, implemented on the Badger. Note: this application is *not* linked from the Launcher by default - it can be run directly using Thonny or your MicroPython editor of choice, or you can modify the Launcher to add it (you'll want to update `launchericons.png` as well)