Skip to content

README.md

Latest commit

 

History

History
37 lines (26 loc) · 1.12 KB

README.md

File metadata and controls

37 lines (26 loc) · 1.12 KB

Introduction to Version Control with Git and GitHub

This lesson uses The Carpentries Workbench template.

Build the lesson locally

To render the lesson locally, you will need to have R installed. Instructions for using R with the Carpentries template is available on the Carpentries website. We recommend using the {renv} package.

After cloning the repository, you can set up renv and install all packages with:

renv::init()
# Optionally update packages
renv::update()

Once you have installed the dependencies, you can render the pages locally by starting R in the project root and running:

sandpaper::serve()

When building the site subsequently, you may need to run renv::activate() first.

This will build the pages and start a local web-server in R and open it in your browser. These pages are "live" and will respond to local file changes if you save them.