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

Update package README using R markdown #22

Open
hturner opened this issue Nov 15, 2019 · 2 comments
Open

Update package README using R markdown #22

hturner opened this issue Nov 15, 2019 · 2 comments
Labels
documentation task related to documentation

Comments

@hturner
Copy link
Contributor

hturner commented Nov 15, 2019

Improve the README to give a bit more information about the package, e.g.

Using usethis::use_readme_rmd() is a good idea as it creates a template and also a git hook to make sure the .Rmd file is rendered to .md before being committed.

@hturner hturner added the documentation task related to documentation label Nov 15, 2019
@hturner
Copy link
Contributor Author

hturner commented Nov 15, 2019

Just discovered there is a GitHub action to update the README too: https://github.com/r-lib/actions/tree/master/examples#render-readme, so maybe we can forget the git hook?

@hturner
Copy link
Contributor Author

hturner commented Nov 15, 2019

Helper functions to use GitHub actions: https://usethis.r-lib.org/reference/github_actions.html

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

No branches or pull requests

1 participant