Skip to content

Commit

Permalink
chore: complete README
Browse files Browse the repository at this point in the history
  • Loading branch information
zaggash committed Dec 20, 2023
1 parent 0113886 commit 46f2410
Showing 1 changed file with 30 additions and 7 deletions.
37 changes: 30 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
## Led-Matrix-UI
## Led-Matrix-UI

WebUI to manage HUB75 LED Matrix Panels with the hzeller/rpi-rgb-led-matrix library

Expand All @@ -7,14 +7,37 @@ Build with:
* Bootstrap
* htmx

## Usage
## Usage

Run as root to get access to the /dev GPIO
Configure it through the app flags
Run as ***root*** to get access to the `/dev` GPIO
Configure it through the app flags
They follow the hzeller library
```
sudo ./matrix-led-ui-bin -h
```

## Build
## Build

TODO
You'll need to install [Zig](https://ziglang.org/) and Golang from your distribution package manager.

Clone the two repos:
* zaggash/go-rpi-rgb-led-matrix
* zaggash/led-matrix-ui

Move to `./go-rpi-rgb-led-matrix/lib/rpi-rgb-led-matrix/lib` and run Make
Then go to the `led-matrix-ui` folder and run build.sh

```
WORKDIR=$(pwd)
git clone https://github.com/zaggash/go-rpi-rgb-led-matrix.git
git clone https://github.com/zaggash/led-matrix-ui.git
cd $WORKDIR/go-rpi-rgb-led-matrix/lib/rpi-rgb-led-matrix/lib/
make \
CC="zig cc -target arm-linux-gnueabihf -march=arm1176jz_s -mfpu=vfp -mfloat-abi=hard" \
CXX="zig c++ -target arm-linux-gnueabihf -march=arm1176jzf_s -mfpu=vfp -mfloat-abi=hard"
cd $WORKDIR/led-matrix-ui/
./build.sh
```


__Please feel free to report any issues or suggestions__

0 comments on commit 46f2410

Please sign in to comment.