In the current design, there is no README.Rmd, but only a README.md.
Previously (I think?) there was a README.Rmd which was then rmarkdown::render()ed to README.md.
This is sometimes used when the README.md absolutely has to show things that were programmatically generated.
WIth a proper documentation site now powered by {pkgdown} and up at http://subugoe.github.io/hoad/ this is no longer necessary.
The README.md now includes only very brief static information about the project.
README.Rmds rendered through to README.md also have the disadvantage that they require you to git commit programmatically created, and therefore derivative files.
As much as absolutely possible, this should be avoided, because it makes the git diffs hard to read and leads to general confusion and is very, very error prone.
(The one exception to this rule is currently everything in man/, which is programmatically created from {roxygen} comments, and therefore derivative, but must remain in the git source because it will otherwise break remotes::install_github() and friends, which is a community standard).
So I'm closing this because README.Rmd isn't actually missing 🙂.
Thanks for reporting this!
In the current design, there is no
README.Rmd, but only aREADME.md. Previously (I think?) there was aREADME.Rmdwhich was thenrmarkdown::render()ed toREADME.md.This is sometimes used when the
README.mdabsolutely has to show things that were programmatically generated. WIth a proper documentation site now powered by {pkgdown} and up at http://subugoe.github.io/hoad/ this is no longer necessary.The
README.mdnow includes only very brief static information about the project.README.Rmds rendered through toREADME.mdalso have the disadvantage that they require you togit commitprogrammatically created, and therefore derivative files. As much as absolutely possible, this should be avoided, because it makes thegit diffs hard to read and leads to general confusion and is very, very error prone.(The one exception to this rule is currently everything in
man/, which is programmatically created from {roxygen} comments, and therefore derivative, but must remain in the git source because it will otherwise breakremotes::install_github()and friends, which is a community standard).So I'm closing this because
README.Rmdisn't actually missing 🙂.