Change README composition and add more information about running

nasa / OnAIR

The On-board Artificial Intelligence Research (OnAIR) Platform is a framework that enables AI algorithms written in Python to interact with NASA's cFS. It is intended to explore research concepts in autonomous operations in a simulated environment.

58 stars 14 forks source link

Change README composition and add more information about running #103

Open asgibson opened 8 months ago

asgibson commented 8 months ago

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.