README.Rmd on GH front page

[gaborcsardi]

It seems that now Github shows README.Rmd before README.md, which is sometimes good, but if you want to show the R output (and hide knitr config), then it is probably not.

I suggest moving README.Rmd to vignettes/, and leaving README.md at its current place. And of course updating the Makefile accordingly. If this is fine, I can send a pull request, of course.

[karthik]

I pushed for this change. But I've also filed a issue to get this fixed. Hopefully early next week.

github/markup#360

[karthik]

I suggest moving README.Rmd to vignettes/, and leaving README.md at its current place. And of course updating the Makefile accordingly. If this is fine, I can send a pull request, of course.

But I do second @gaborcsardi's suggestion until the fix is pushed through.

[stewid]

I also second @gaborcsardi's suggestion to use README.md

It was reported problematic to install with a vignette in issue #14

I tried to install git2r today on Windows 8.1
The package vignette does not build on Windows, so I can only install by using
install_github("git2r", "ropensci", build_vignettes=FALSE)

I removed the vignette to solve the issue. Maybe we can just drop README.Rmd for now?

[stewid]

I dropped README.Rmd

[karthik]

But just for future ref, GitHub did fix the rendering order. Rmd and rmd will now always render after the md.

[stewid]

👍