[meom code clinic] general structure (having a readme, a licence, contributing guide, etc)

[rcaneill]

• Package has a README.md file in the root directory.
• Package documentation is easy to find.
• The package is easy to install
• License: Does the repository contain a plain-text LICENSE or COPYING file with the contents of an OSI approved software license?
• Community guidelines: Are there clear guidelines for third parties wishing to 1) Contribute to the software 2) Report issues or problems with the software 3) Seek support
• Metadata including author(s), author e-mail(s), a url, and any other relevant metadata e.g., in a pyproject.toml file or elsewhere.

[stephanieleroux]

• README file: ok
• Licence: ok
• General doc easy to find but practical examples not easily findable: the readme could include examples of how to use or links to some of the examples
• The doc of all the functions is not easy to browse and interact with
• Julia doc missing
• Community guidelines: missing (contribute, report issues, support)
• Metadata: add author(s), author e-mail(s) in the Readme?