diff --git a/README.md b/README.md index 08d06a8..f0dead5 100644 --- a/README.md +++ b/README.md @@ -284,10 +284,12 @@ kyber::call_agenda( call_number = 4) ``` -1. To review the call agenda, open `agenda.md`, click Preview, and view it in the Viewer Tab. +6. To review the call agenda, open `agenda.md`, click Preview, and view it in the Viewer Tab. Usually you can repeat steps 3-5 whenever you make edits you want to review, however if there are problems try restarting you R session. +To update the template for all Cohort README.Rmd's, edit [`inst/rmarkdown/templates/openscapes-cohort-readme/skeleton/skeleton.Rmd`](https://github.com/Openscapes/kyber/blob/main/inst/rmarkdown/templates/openscapes-cohort-readme/skeleton/skeleton.Rmd) + ## Contributing to Kyber To contribute to Kyber, fork the repo, unchecking the "Copy the main branch only" box. Start working from the `dev` branch, create a new branch like `new-branch dev`, and then submit Pull Requests to `dev`. If using Git on the command line the workflow would look like: @@ -300,5 +302,5 @@ To contribute to Kyber, fork the repo, unchecking the "Copy the main branch only - then `git push origin new-branch` - keep adding, committing, and pushing, then when you're ready open a PR -We started using this workflow when the [California Water Boards Openscapes]((https://cawaterboarddatacenter.github.io/swrcb-openscapes/) team began using Kyber to create Agendas from some unique source Rmd files. For example, Water Boards Cohort Calls are 2 hours, not the default 1.5 hrs, their lesson order is different from Openscapes Core Lessons, and includes a new lesson on Documentation. +We started using this workflow when the [California Water Boards Openscapes](https://cawaterboarddatacenter.github.io/swrcb-openscapes/) team began using Kyber to create Agendas from some unique source Rmd files. For example, Water Boards Cohort Calls are 2 hours, not the default 1.5 hrs, their lesson order is different from Openscapes Core Lessons, and includes a new lesson on Documentation.