Add contact information, team and project info to README.md

HydrologyFrankfurt / ReWaterGAP

GNU Lesser General Public License v3.0

4 stars 0 forks source link

Add contact information, team and project info to README.md #6

Closed rreinecke closed 1 year ago

rreinecke commented 1 year ago

Since the project is now public please add a short info to the README on:

A remark that his is still under development
Very short summary what this is about and that it is funded by the DFG
A list of the team and their responsibilities (including link to github profiles)
And a contact person and email for questions regarding the project

-> We haven't launched officially yet but someone might discover this project by accident so it would be good to have at least some info for people to follow up on :).

Leon-Muehlenbruch commented 1 year ago

I've written a first draft of a readme which can be found where the readme is located. In the first step I wanted to get all the important information down

relevant links
list of team members and their roles
introduction to the project

Is there an official list of people that work on this that I can use for the readme? Is there an official "spokesperson" and email people can contact?

Never wrote a readme before so I'll gladly take any suggestions!

rreinecke commented 1 year ago

Nice!

Add Emmanuel's mail as main contact
Use the links like that makes it a bit more readable

I think for a first version this is already really nice :). Maybe have a look at other big projects on Github and see how they design the readme. Something that you could then discuss with Emmanuel for an improved version later on.