diff options
| -rw-r--r-- | README.md | 16 |
1 files changed, 9 insertions, 7 deletions
@@ -1,14 +1,18 @@ +# Unicorn Paint A painting webapp, controlling a [16x16 LED matrix](https://shop.pimoroni.com/products/unicorn-hat-hd). It allows multiple people to paint at once & updates in real time. This project includes the following components: -A [Go library](https://github.com/MFAshby/unicornpaint/tree/master/unicorn) for controlling the physical device -A [Go web server](https://github.com/MFAshby/unicornpaint/blob/master/Server.go) utilising websocket communication -A [React JS client application](https://github.com/MFAshby/unicornpaint/tree/master/src) -Distribution & deployment with [Docker](https://github.com/MFAshby/unicornpaint/blob/master/Dockerfile) +* A [Go library](https://github.com/MFAshby/unicornpaint/tree/master/unicorn) for controlling the physical device +* A [Go web server](https://github.com/MFAshby/unicornpaint/blob/master/Server.go) utilising websocket communication +* A [React JS client application](https://github.com/MFAshby/unicornpaint/tree/master/src) +* Distribution & deployment with [Docker](https://github.com/MFAshby/unicornpaint/blob/master/Dockerfile) Live example hosted at: https://unicorn.mfashby.net + + +## Running Ensure SPI is enabled on your raspberry pi: ``` sudo raspi-config nonint do_spi 0 @@ -26,10 +30,8 @@ Or download the [docker-compose](https://raw.githubusercontent.com/MFAshby/unico docker-compose up -d ``` -Or install Go and run directly with +Or install Go, clone the repository & run directly with ``` go get github.com/ecc1/spi github.com/gorilla/websocket github.com/MFAshby/unicornpaint/unicorn go run Server.go ``` - - |