updated readme.md

This commit is contained in:
Timo Volkmann 2021-01-15 20:16:12 +01:00
parent a40a8c5ffd
commit 793d68d3ee

View File

@ -9,7 +9,7 @@ First copy `example_config.yml` to `gpsconfig.yml` and adjust your parameters. i
## Preparation ## Preparation
Make sure you prepared your GPS device like described in chapter 3.3 of the Documentation. Make sure you prepared your GPS device like described in chapter 3.3 of the Documentation.
Start gyrogpsc **before** connecting your smartphone via TCP. Start gyrogpsc **before** connecting your smartphone via TCP. Make sure you updated the config file with the correct COM port for your ublox device, before starting the Serial Collector from the UI.
## Run ## Run
Execute `gyropgsc-$OS`, according to your operating system. Execute `gyropgsc-$OS`, according to your operating system.
@ -24,15 +24,20 @@ Execute `gyropgsc-$OS`, according to your operating system.
1. `git clone --recursive https://git.timovolkmann.de/tvolkmann/gyrogpsc.git` 1. `git clone --recursive https://git.timovolkmann.de/tvolkmann/gyrogpsc.git`
2. run `go install` from project root 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 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
4. open `http://localhost:3011`
## Build ## Build
For Windows 64-bit: `GOOS=windows GOARCH=amd64 go build -o build/gyrogpsc-win.exe cmd/server/server.go` For your platform only: `go build cmd/server/server.go`
For MacOS: `GOOS=darwin GOARCH=amd64 go build -o build/gyrogpsc-mac cmd/server/server.go` **Cross-Platform Builds:**
For Linux: `GOOS=linux GOARCH=arm64 go build -o build/gyrogpsc-linux cmd/server/server.go` For Windows 64-bit: `GOOS=windows GOARCH=amd64 go build -o gyrogpsc-win.exe cmd/server/server.go`
Make sure that binaries have execute permissions on Mac and Linux. Currently only working on 64-bit systems. For MacOS: `GOOS=darwin GOARCH=amd64 go build -o gyrogpsc-mac cmd/server/server.go`
For Linux: `GOOS=linux GOARCH=arm64 go build -o gyrogpsc-linux cmd/server/server.go`
Make sure that binaries have execute permissions on Mac and Linux. Currently only working on 64-bit systems. Cross Platform commands only working on Mac & Linux.
## Static files and demo database ## Static files and demo database
### Demo database ### Demo database