Content: writing good documentations about module-5-open-research-software-and-open-source

[Remi-Gau]

I think it is better to close the issue for now. I had some other ideas but most of them are too raw, halfbaked and generally disorganized that I can write them down.
I might reopen it later and or directly send a PR once I got it sorted.

[schlauch]

I think that this is a good point. In addition, the README is the first impression that you make and it is a kind of light-weight documentation artifact. I found some examples of how to structure READMEs here: https://github.com/matiassingers/awesome-readme#tools

[Protohedgehog]

That's a good idea! Do you mean things like good README files? We have a bit of that in the first Task, but it could perhaps be expanded on there?

[Protohedgehog]

I've already included some information here on how to write a good README file. But please do expand on it if you think it can be improved! @Remi-Gau @schlauch :)

[Protohedgehog]

Pinging @Remi-Gau and @schlauch - do you think this is okay for now, so I can close this issue, or still room for improvement? :)

[schlauch]

Yes, I think that task 1 already does a good Job explaining the basic aspects :)

[Protohedgehog]

OK, will wait for @Remi-Gau to have a look before closing this - thank you!!

[Protohedgehog]

OK, sweet, thanks @Remi-Gau! Would be sweet to get back on this as your thoughts develop, but I think we at least have the basics covered for now :)