Skip to content

Commit

Permalink
Updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
jinglemansweep committed Dec 7, 2024
1 parent 7a578be commit 222e462
Showing 1 changed file with 16 additions and 1 deletion.
17 changes: 16 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -145,6 +145,8 @@ Each Entity tile must be created as a Python class which can then be added to Co

## Installation

### RGB LED Matrix Driver

Fetch dependencies submodules:

git submodule update --init --recursive
Expand All @@ -154,6 +156,19 @@ Build `rpi-rgb-led-matrix` Python bindings:
cd lib/rpi-rgb-led-matrix
make build-python

### Python 3.10

If using Debian Bookworm, you will need to install Python 3.10 as the default 3.9 version will not work. You can add an APT repository to install Python 3.10 packages:

Add the following to `/etc/apt/sources.list` or equivalent:

deb http://deb.pascalroeleven.nl/python3.10 bullseye-backports main

Install:

apt update
apt install python3.10

## Configuration

Project configuration is provided using [Dynaconf](https://www.dynaconf.com/), meaning that configuration can be provided using one or more TOML files, but can also be overridden at runtime using environment variables. For more information, see [`config.py`](./wideboy/config.py).
Expand Down Expand Up @@ -182,7 +197,7 @@ Any configuration value can be applied using environment variables which all sta

## Development

Create a Python 3.x virtual environment, and install project dependencies:
Create a Python 3.10+ virtual environment, and install project dependencies:

python3 -m venv venv
. venv/bin/activate
Expand Down

0 comments on commit 222e462

Please sign in to comment.