unicornpaint

Unnamed repository; edit this file 'description' to name the repository.
Log | Files | Refs | README

commit e6060fb69c32dcdf5904793e61e4b272bbd79de2
parent b1901053b8fe1391e5b92b060a3e263ff799a745
Author: MFAshby <MFAshby@users.noreply.github.com>
Date:   Tue, 22 May 2018 10:07:05 +0100

Update README.md
Diffstat:
MREADME.md | 16+++++++++-------
1 file changed, 9 insertions(+), 7 deletions(-)

diff --git a/README.md b/README.md @@ -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 +![screenshot](https://github.com/MFAshby/unicornpaint/raw/master/Screenshot.png "Screenshot") + +## 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 ``` - -![alt text](https://github.com/MFAshby/unicornpaint/raw/master/Screenshot.png "Screenshot")