aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMFAshby <MFAshby@users.noreply.github.com>2018-05-22 10:07:05 +0100
committerGitHub <noreply@github.com>2018-05-22 10:07:05 +0100
commite6060fb69c32dcdf5904793e61e4b272bbd79de2 (patch)
tree1752d985833c6a863229ca11d2800624d4d9c160
parentb1901053b8fe1391e5b92b060a3e263ff799a745 (diff)
downloadunicornpaint-e6060fb69c32dcdf5904793e61e4b272bbd79de2.tar.gz
unicornpaint-e6060fb69c32dcdf5904793e61e4b272bbd79de2.tar.bz2
unicornpaint-e6060fb69c32dcdf5904793e61e4b272bbd79de2.tar.xz
unicornpaint-e6060fb69c32dcdf5904793e61e4b272bbd79de2.zip
Update README.md
-rw-r--r--README.md16
1 files 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")