Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Usage guide in the repository's GitHub wiki #26

Open
linguini1 opened this issue Jun 9, 2023 · 0 comments
Open

Usage guide in the repository's GitHub wiki #26

linguini1 opened this issue Jun 9, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@linguini1
Copy link
Collaborator

linguini1 commented Jun 9, 2023 •
edited
Loading

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
@linguini1 linguini1 added documentation Improvements or additions to documentation good first issue Good for newcomers labels Jun 9, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@linguini1