FAIRDataTeam / FAIRifier

A tool to make data FAIR
MIT License
14 stars 8 forks source link

Updated Readme of the FAIRifier #29

Closed Shamanou closed 7 years ago

Shamanou commented 7 years ago

I changed the readme to contain text and links about dtl and related project putting the FAIRifier in context

kburger commented 7 years ago

For a next iteration, you should think about adding section headers. For now, if you can make the changes Rajaram suggested, I'm OK with this.

kburger commented 7 years ago

We found a good template that you(/we all) can use as a base for a good readme: A template to make good README.md (and read this one for a more in depth explanation on certain sections)

I propose to use this template, with the following exceptions:

As for the wiki, take a look at these open source projects for inspiration on how they organised their wiki pages. Generally, they have a main page with an explanation and links to the wiki sections.

Try to update the readme and wiki pages as much as you can according to these examples.

rajaram5 commented 7 years ago

For now I will approve it but we have to revisit this issue in later sprint

kburger commented 7 years ago

I'm with Rajaram, and be careful in the future with pushing to an open PR. This PR now incorporates f41724c and ce08307 as well, which I didn't properly review.