search

ropensci / RNeXML

Implementing semantically rich NeXML I/O in R
https://docs.ropensci.org/RNeXML
Other
13 stars 9 forks source link

Clean up README, or use to build website #222

Closed hlapp closed 5 years ago

hlapp commented 5 years ago

Wondering if we should clean up the README a bit more while we are at it. I can clean up the badge list (we don't need two coverage badges, looks like our appveyor setup needs mending since it's not active...) but there's a bit of a philosophical divide between whether pkg root README should be a more minimal motivation/install/quickstart (with the details handled in vignettes linked from the readme) or a more complete all-the-essentials style document. For the former it would be good to run pkgdown::build_site() to get an HTML version of the docs and vignettes as well.... thoughts?

Originally posted by @cboettig in https://github.com/ropensci/RNeXML/pull/221#issuecomment-442327560

hlapp commented 5 years ago

I actually fully agree on both counts. That is, either have a relatively minimal README that neither duplicates what is in the vignettes nor serves as a quasi-vignette (which then, if it isn't duplicated, is missing from from the package vignettes), or have it be part of a generated package website.

Overall I think the latter has a major upside, namely that someone interested or curious can explore and learn about the package without having to make any kind of commitment (a.k.a. installing it, which will install its dependencies, etc). And browsing vignettes and documentation on the web, if nicely rendered (which pkgdown seems to accomplish), is much more pleasant on the eye than doing so in RStudio.

hlapp commented 5 years ago

Completed through #223 and #226.