add info on VC to template readme - closes #176

weecology · Mar 31, 2020 · 03e3ee3 · 03e3ee3
1 parent 0cf5535
commit 03e3ee3
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 2 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,4 +1,3 @@
-/inst/doc
 .Rproj.user
 .Rhistory
 .RData
@@ -12,5 +11,5 @@
 Meta
 /inst/extdata/subsampled/breed-bird-survey-prepped
 /inst/extdata/subsampled/biotime-prepped
+/inst/templates/template-README.html
 README_cache
-doc
diff --git a/inst/templates/template-README.md b/inst/templates/template-README.md
@@ -115,3 +115,11 @@ In `analysis/pipeline.R`, you will want to modify the `methods` drake plan to in
 
 3. **Add code to process and plot the results.**
 In `analysis/report.Rmd`, you will want to modify the code to read in the new results, process the output, and construct plots.
+
+## Set up version control
+
+`MATSS` compendia are designed to be easily distributible via code-sharing platforms, such as Github. An example compendium, built using the latest version of `MATSS` can be found at https://github.com/weecology/MATSSdemo.
+
+A guide to setting up Git and getting the compendium uploaded to Github is in [this chapter](http://r-pkgs.had.co.nz/git.html) of Hadley Wickham's book on R packages.
+
+For a more extensive resource on using Git and Github as part of your coding workflow, see [Happy Git and GitHub for the useR](https://happygitwithr.com/).