Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DOCS: How is README.md stripped and included on package page? #76

Open
HenrikBengtsson opened this issue Nov 16, 2015 · 2 comments
Open

Comments

@HenrikBengtsson
Copy link

I see that some packages have extensive documentation on their METACRAN package pages, e.g. http://www.r-pkg.org/pkg/ggplot2 and http://www.r-pkg.org/pkg/knitr.

My best guess is that this extra information is incorporated if there exist a README.md file in the built package *.tar.gz. Is this correct? Does README.md need to be installed as well, or is it enough if it is part of *.tar.gz, e.g. excluded by R.instignore?

Is METACRAN getting this from the *.tar.gz file or from elsewhere such as https://github.com/cran/?

I'm asking because I added README.md to https://cran.r-project.org/package=R.cache (new version on CRAN since 2015-11-12), but its content does not show on http://www.r-pkg.org/pkg/R.cache. I noticed that https://github.com/cran/R.cache hasn't been updated - could that be why?

@gaborcsardi
Copy link
Contributor

Hi Henrik, these are the readmes that we pick up, from the tar.gz published on CRAN: https://github.com/metacran/readme-builder-app/blob/5c9af5a33f68d7fcc59bd16509b3d6fd59919d20/lib/build_readme.js#L8-L11

Indeed, the https:://github.com/cran pages are not updated now, simply because I left Harvard and they turned off my server. That's why readmes from the newly updated and published packages are not picked up.

I'll fix it soon. Sorry for the inconvenience.

@tbates
Copy link

tbates commented Oct 13, 2016

I see this is still the case... anything we can do to help?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants