Skip to content

Latest commit

 

History

History
84 lines (52 loc) · 2.44 KB

README.rst

File metadata and controls

84 lines (52 loc) · 2.44 KB
Raw

Introduction

Documentation Status Discord Build Status Code Style: Black

A CircuitPython DisplayIO widget for annotating other widgets or freeform positions.

Dependencies

This driver depends on:

Please ensure all dependencies are available on the CircuitPython filesystem. This is easily achieved by downloading the Adafruit library and driver bundle or individual libraries can be installed using circup.

Installing from PyPI

On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally from PyPI. To install for current user:

pip3 install circuitpython-displayio-annotation

To install system-wide (this may be required in some cases):

sudo pip3 install circuitpython-displayio-annotation

To install in a virtual environment in your current project:

mkdir project-name && cd project-name
python3 -m venv .env
source .env/bin/activate
pip3 install circuitpython-displayio-annotation

Usage Example

See scripts in the examples directory of this repository.

Contributing

Contributions are welcome! Please read our Code of Conduct before contributing to help this project stay welcoming.

Documentation

For information on building library documentation, please check out this guide.