Open-MBEE / perseverance-modelica

Modelica model of the Mars Perseverance rover
Apache License 2.0
3 stars 5 forks source link

Provide better usage guidance in README #7

Closed lewismc closed 11 months ago

lewismc commented 1 year ago

Currently the README is extremely vague with regards to how to actually import and run experiment(s). We can improve the documentation which will lower the barrier to entry for new users of this project... specifically new users who may not be overly familiar even with the Modelon graphical user interface. I propose that each experiment (Perseverance, Ingenuity and ExampleModels) have it's own README with clear directions on how to import and run the experiment. Each README can then simply be linnked to from the parent README.