Create a readme

added UX/UI label

changed milestone to %ThermoSysPro v4.1

Refer to ContributionsWorkflow.md in a "How to Contribute" section.

Has been made

closed

I propose to keep this issue open, since we have to improve our README which is way too basic currently (see for exemple my previous comment in this issue, but many more "sections" could be added.

reopened

mentioned in issue #60

For example, looking @:

• https://github.com/lbl-srg/modelica-buildings
• https://github.com/Metroscope-dev/metroscope-modeling-library

(Fill free to use other examples) I think we should need the following sections:

• Description: To be improved ?
• Roadmap:
  • Main expected features
• Documentation:
  • The book
  • The website
  • Future: in the models
• How to contribute
  • Report à bug -> Link to md on labels&co?
  • Develop -> Link to md workflow
• Citation -> The book
• Global references: recall all available resources @ once? For exemple workflow, website, book...

mentioned in merge request !7 (merged)

mentioned in commit e8e40310

mentioned in commit e3286e75

Improved README with !7 (merged). Can be reopened if needed

closed