search

Project-ARTist / meta

Meta repository for matters related to more than one repository or even the whole project as such.
2 stars 0 forks source link

Proper READMEs #10

Closed schrnz closed 6 years ago

schrnz commented 6 years ago

README.md files are the landing pages of repositories, hence these are the first thing new users see when they visit one of our repositories. Currently, however, those READMEs are not very helpful or even (almost) non-existent. Since we want to make it easier for new users to join our project and work with ARTist, we should have helpful README files that provide some basic information and point at further resources where they can find help. Beside information about the actual repository, it should also give a basic introduction into the overall ARTist project and put the repository in context. Also, a pointer to the documentation and Gitter group would help.

Tasklist

Check a task as soon as a proper README.md file has been committed in the corresponding project.

schrnz commented 6 years ago

New README files reside in the README-v2 branches in each repository, respectively.

schrnz commented 6 years ago

The new README files are already merged.