trias-project / alien-fishes-checklist

🐟 Checklist of non-native freshwater fishes in Flanders, Belgium
https://trias-project.github.io/alien-fishes-checklist
MIT License
0 stars 1 forks source link

Add README #15

Closed LienReyserhove closed 6 years ago

LienReyserhove commented 6 years ago

I made a new README for the checklist or non-native freshater fish. I used the README of the Manual of Alien Plants as a base document, but I made some changes in an attempt to make the structure more logical.

  1. I tried to indicate more clearly where you can find the description of the mapping process (i.e. the mapping script).

  2. I found it a little bit weird that we provide a result section only. I prefer to use the input - code (?) - results (output?) structure.

These are some suggestions, open to discussion :-)

peterdesmet commented 6 years ago

Updated: README now looks like this: https://github.com/trias-project/alien-fishes-checklist/tree/write-readme

@LienReyserhove If you agree, this can be merged.