From e6060fb69c32dcdf5904793e61e4b272bbd79de2 Mon Sep 17 00:00:00 2001 From: MFAshby Date: Tue, 22 May 2018 10:07:05 +0100 Subject: Update README.md --- README.md | 16 +++++++++------- 1 file changed, 9 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 0c73710..4cb1824 100644 --- 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") -- cgit v1.2.3-ZIG