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

Take the best of both README templates #1287

Merged
merged 3 commits into from Aug 8, 2016

Conversation

Projects
None yet
3 participants
@jennybc
Member

jennybc commented Aug 6, 2016

Unify the template for README.Rmd and README.md, so that both contain scaffold for

  • what does this package do?
  • how to install (if GitHub usage detected)
  • an example

I expanded the help. The use of whisker/mustache is very much "brute force" but it's simple to maintain.

The first commit should be taken, no matter what, as it fixes a general problem with use_template() & RStudio.

I'm happy to write tests (and have tested all 4 combinations of Rmd vs md * Github yes vs no), but I didn't see any others for this sort of thing.

@hadley hadley merged commit 3546faa into r-lib:master Aug 8, 2016

4 checks passed

codecov/patch 88.88% of diff hit (target 49.63%)
Details
codecov/project 50.01% (+0.37%) compared to 927fbb8
Details
continuous-integration/appveyor/pr AppVeyor build succeeded
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details
@hadley

This comment has been minimized.

Member

hadley commented Aug 8, 2016

Looks great - thanks!

@jennybc jennybc deleted the jennybc:readme-templates branch Aug 9, 2016

krlmlr added a commit to krlmlr/devtools that referenced this pull request Aug 17, 2016

Take the best of both README templates (r-lib#1287)
* Use correct path in open_in_rstudio()

* Unified README template w/ sections for overview, installation, example

* add bullet to NEWS.md

krlmlr added a commit to krlmlr/devtools that referenced this pull request Aug 24, 2016

Take the best of both README templates (r-lib#1287)
* Use correct path in open_in_rstudio()

* Unified README template w/ sections for overview, installation, example

* add bullet to NEWS.md

krlmlr added a commit to krlmlr/devtools that referenced this pull request Aug 24, 2016

Take the best of both README templates (r-lib#1287)
* Use correct path in open_in_rstudio()

* Unified README template w/ sections for overview, installation, example

* add bullet to NEWS.md
@krlmlr

This comment has been minimized.

Member

krlmlr commented Aug 24, 2016

This patch has been corrupted in master, working on restoring it.

krlmlr added a commit to krlmlr/devtools that referenced this pull request Aug 24, 2016

@krlmlr

This comment has been minimized.

Member

krlmlr commented Aug 24, 2016

Luckily, it was only the master branch in my fork. Please ignore.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment