Materials-Data-Science-and-Informatics / somesy

A CLI tool for synchronizing software project metadata
https://materials-data-science-and-informatics.github.io/somesy/main/
MIT License
12 stars 2 forks source link

update documentation #94

Open mustafasoylu opened 4 months ago

mustafasoylu commented 4 months ago

After talking with some of our users, I wanted to update the documentation in several places.

  1. Set a note explaining they don't have to install somesy to their PC or add it as a dependency if they use it as a pre-commit hook.
  2. fix the version to the latest in the somesy.toml example
  3. add a note to warn users of the latest version
  4. explain why we set some fields as compulsory fields

When setting somesy up in the prototyping phase, we discussed the compulsory fields with Anton. It is not much, and a project should have at least that much metadata in its repository, else somesy doesn't mean anything anyway. However, we can discuss whether we should change the current compulsory fields.

Compulsory fields for project metadata:

Compulsory fields for project metadata: