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

Change README composition and add more information about running #103

Open
asgibson opened this issue Dec 19, 2023 · 0 comments · May be fixed by #164
Open

Change README composition and add more information about running #103

asgibson opened this issue Dec 19, 2023 · 0 comments · May be fixed by #164
Labels
documentation Improvements or additions to documentation help wanted Extra attention is needed

Comments

@asgibson
Copy link
Contributor

The current README offers no explanation of anything in the system except:

  • creating a Conda environment (doesn't explain why or what to do afterward)
  • running unit tests (important but comprises the bulk of the README)
  • License and contributor information

Need to add things like how to:

  • write a config.ini file
  • write a plugin
  • run

Additionally, information about system flow.
@asgibson asgibson added documentation Improvements or additions to documentation help wanted Extra attention is needed labels Dec 19, 2023
@asgibson asgibson linked a pull request Nov 8, 2024 that will close this issue
103 change readme composition and add more information about running #164
Draft
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 help wanted Extra attention is needed
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

103 change readme composition and add more information about running nasa/OnAIR
1 participant
@asgibson