readme.md update

2021-01-06 17:29:22 +01:00 · 2021-01-06 17:29:22 +01:00 · a7f6e2b9a1
commit a7f6e2b9a1
parent e66f631c2f
1 changed files with 17 additions and 0 deletions
--- a/readme.md
+++ b/readme.md
@ -0,0 +1,17 @@
+# gyropsc ⚡
+**Realtime Location Dashboard 🚀**
+## Quickstart
+### Requirements
+* Win, Linux or Mac Computer, ideally with serial port and WiFi
+* 
+
+## Build from source
+### Requirements
+* git
+* go >1.15
+
+### Build Steps
+1. clone repository
+2. run `go install` from project root
+3. run `go run cmd/server/server.go` from project root to start application or just `go build cmd/server/server.go` for building it only
+