Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 24 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,19 +12,39 @@

## Installation

`RGBMatrixEmulator` is in the [Python Package Index (PyPI)](http://pypi.python.org/pypi/RGBMatrixEmulator/).
Installing with ``pip`` is recommended for all systems.
`RGBMatrixEmulator` is in the [Python Package Index (PyPI)](http://pypi.python.org/pypi/RGBMatrixEmulator/). Installing with `pip` is recommended for all systems.

```sh
pip install RGBMatrixEmulator
```

### Experimental `pi5` Adapter
The base installation includes the following display adapters:

To use the experimental `pi5` adapter, you can install the optional adapter as follows. This installation is only valid for Raspberry Pi 5 hardware.
* `browser` (default)
* `terminal`
* `tkinter`
* `turtle`
* `raw`

For more information on display adapters, see the [Display Adapters](#display-adapters) section.

### Optional Adapters

The following adapters are supported but not installed by default.

* `sixel`
* `pygame`
* `pi5` (experimental)

You can install optional adapters via `pip`:

```sh
pip install RGBMatrixEmulator[sixel]
pip install RGBMatrixEmulator[pygame]
pip install RGBMatrixEmulator[pi5]

# All optional adapters at once
pip install RGBMatrixEmulator[sixel,pygame,pi5]
```

## Usage
Expand Down
10 changes: 7 additions & 3 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -33,17 +33,21 @@ classifiers = [
]
dependencies = [
"bdfparser<=2.2.0",
"libsixel-python>=0.5.0",
"numpy>=1.2.0",
"Pillow>=10.0.1",
"pygame>=2.0.1,<3",
"tornado>=6.5.5"
"tornado>=6.5.5",
]

[project.scripts]
rgbme = "RGBMatrixEmulator.cli:run_cli"

[project.optional-dependencies]
pygame = [
"pygame>=2.0.1,<3",
]
sixel = [
"libsixel-python>=0.5.0",
]
pi5 = [
"Adafruit-Blinka-Raspberry-Pi5-Piomatter>=1.0.0; python_version>='3.11'",
"adafruit-blinka>=8.0.0; python_version>='3.11'",
Expand Down
2 changes: 0 additions & 2 deletions test/reference.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,6 @@
TestConfigContext,
)

os.environ["RGBME_SUPPRESS_ADAPTER_LOAD_ERRORS"] = "true"

sys.path.append(os.path.abspath(os.path.join(__file__, "..", "..")))

import samples
Expand Down
14 changes: 9 additions & 5 deletions uv.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading