How to syncronize the README.Rmd and README.md?

[avallecam]

I frequently forget to update the README.md file. Is there a way to automatize this process?

[avallecam]

You can use the usethis::use_readme_rmd() function. This function conditions your README commits to keep the Rmd and the md files synchronized.

• Run usethis::use_readme_rmd(). This will ask you to overwrite your pre-existing README.Rmd file.
• Copy your current README.Rmd content. This is to keep the README template content generated by {rcompendium}
• Confirm the overwrite

The output message ✔ Writing '.git/hooks/pre-commit' confirms that there is an internal configuration to keep both files synchronized.

There is one more step to do:

• Activate the Knit on Save button. Find this in the upper left corner of the Source pane (the place to open R scripts and files). This will create the md file each time you edit and save the Rmd file.

More details on how this works and how to delete this configuration in the ?usethis::use_readme_rmd() reference documentation:

The hook creates friction if you try to commit when README.Rmd has been edited more recently than README.md. If this hook causes more problems than it solves for you, it is implemented in .git/hooks/pre-commit, which you can modify or even delete.