Update README.md - Githubissues

trias-project / uredinales-belgium-checklist

🍃 Catalogue of the Rust Fungi of Belgium

https://trias-project.github.io/uredinales-belgium-checklist

MIT License

0 stars 1 forks source link

Update README.md #11

Closed LienReyserhove closed 6 years ago

LienReyserhove commented 6 years ago

I updated the README. Most important changes: see section ## Installation. The rest is adapted from the alien fishes repository.

peterdesmet commented 6 years ago

Some comments (from phone)

Don’t use dots for names and after year in citations (see citation format in other repos)
Use backticks to refer to file names, not douvle quotes
Repo structure heading appears twice
Rmd should be rendered to docs: update repo structure and installation. See fishes (I guess) for inspiration

😊

LienReyserhove commented 6 years ago

Point 1-3: done

Point 4: In the fishes repo, we refer to the README of alien plants for the installation part. We haven't written an installation guide yet for .Rmd files. This was a first attempt. At this point, there's no docs folder present yet. I'm still not very familiar with this whole rendering process of .Rmd files to these nice documents, so maybe you should enlighten me :smile:

peterdesmet commented 6 years ago

I've just added the site to this branch. To be done:

[x] Update installation steps
[x] Update repo structure, see https://github.com/trias-project/alien-fishes-checklist/blob/master/README.md#repo-structure
[x] Avoid too many links in README and use absolute links
[x] Don't use , in references

LienReyserhove commented 6 years ago

Done.

With respect to the installation guide, I removed run or adapt the code. I think it is sufficient to know how to run the code. To adapt the code, you really need more GithHub skills then those listed in the installation guide. Maybe we could add a "report an issue" section, to indicate that comments are always welcome.