What can be a README file? #7

andreaadao · 2023-04-06T21:21:43Z

andreaadao
Apr 6, 2023
Maintainer

A few weeks ago, I had a go on updating the main README.md file, the one featured on the organization's main page here on github: https://github.com/colab-at. The idea was to quickly have a welcome message with enough information about what we're aiming for Colab and this new project space, and to achieve that I used Pedro's Back to Colab introductory post as reference.

Now, and as a preparation for launching Colab, we should have a closer look at these type of files, that we should have on each repository,

understanding what can be a readme file
what kind of information is the most useful to have there,
and also, considering what the community is used to expect from them.

And at the same time, come up with a How to create them, with a basic structure as a guide to follow, so we can easily go back to it at any time.