diff --git a/readme.md b/readme.md index e69de29..d8205b7 100644 --- 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 +