Skip to content

Commit

Permalink
Update README.md (#1)
Browse files Browse the repository at this point in the history
Add build instructions, update c library url.
SWIG build has '-threads' argument for recent GIL patch.
  • Loading branch information
stephen322 committed Oct 4, 2023
1 parent b85643f commit 0e1dfb1
Showing 1 changed file with 20 additions and 1 deletion.
21 changes: 20 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# RPi WS281x Python

This is the official Python distribution of the ws281x library: http://github.com/richardghirst/rpi_ws281x
This is the official Python distribution of the ws281x library: https://github.com/jgarff/rpi_ws281x

# Installing

Expand All @@ -11,3 +11,22 @@ Most users should simply run:
```
sudo pip install rpi_ws281x
```

## Building

Clone with submodules, and enter library directory:
```
git clone --recurse-submodules https://github.com/rpi-ws281x/rpi-ws281x-python.git
cd rpi-ws281x-python/library
```
To rebuild SWIG files if needed ("black" for code re-formatting only):
```
swig -python -threads rpi_ws281x.i
black rpi_ws281x.py
```

Build and Install:
```
python3 setup.py build
sudo python3 setup.py install
```

0 comments on commit 0e1dfb1

Please sign in to comment.