Usage guide in the repository's GitHub wiki - Githubissues

CarletonURocketry / ground-station

The ground station software used to interface with the ground station LoRa board and distribute signals from the rocket across websocket connections.

https://carletonurocketry.github.io/ground-station/

MIT License

7 stars 6 forks source link

Usage guide in the repository's GitHub wiki #26

Open linguini1 opened 1 year ago

linguini1 commented 1 year ago

Problem

There are no instructions on how to use the ground station software written in the GitHub wiki.

Proposed solution

A guide for how to operate the ground station software should be included in the GitHub wiki.

Should include

Helpful command line arguments (try not to duplicate the -h help menu, but provide steps for discovering it)
Best practices (log files should be .log not .txt)
How to check ground station COM port from device manager (on Windows, Linux alternative can also be provided)
Available websocket commands for the test.html file/web interface