Start converting slides

Author: ZedThree

CITATION.cff

@@ -5,18 +5,21 @@
 # ensuring that the author list and other fields remain accurate.
 
 cff-version: 1.2.0
-title: FIXME
+title: Introduction to Version Control with Git and GitHub
 message: >-
   Please cite this lesson using the information in this file
   when you refer to it in publications, and/or if you
   re-use, adapt, or expand on the content in your own
   training material.
 type: dataset
 authors:
-  - given-names: FIXME
-    family-names: FIXME
+  - family-names: Hill
+    given-names: Peter Alec
+    orcid: https://orcid.org/0000-0003-3092-1858
+    affiliation: University of York
+
 abstract: >-
-  FIXME Replace this with a short abstract describing the
-  lesson, e.g. its target audience and main intended
-  learning objectives.
-license: CC-BY-4.0
+  A beginner's introduction to version control, walking through the basics of
+  setting up a git repository, making changes, undoing changes, and working with
+  others.
+license: CC-BY-SA-4.0

README.md

@@ -1,3 +1,37 @@
-## intro-to-version-control
+## Introduction to Version Control with Git and GitHub
 
-    This is the lesson repository for intro-to-version-control
+This lesson uses [The Carpentries Workbench][workbench] template.
+
+### Build the lesson locally
+
+To render the lesson locally, you will need to have [R][r] installed.
+Instructions for using R with the Carpentries template is available on the
+[Carpentries website](https://carpentries.github.io/workbench/#installation).
+We recommend using the
+[`{renv}`](https://rstudio.github.io/renv/articles/renv.html) package.
+
+After cloning the repository, you can set up `renv` and install all packages with:
+
+``` r
+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:
+
+``` r
+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.
+
+
+[git]: https://git-scm.com
+[r]: https://www.r-project.org/
+[workbench]: https://carpentries.github.io/workbench/

config.yaml

@@ -17,56 +17,37 @@ carpentry: 'incubator'
 # carpentry_description: "Custom Carpentry"
 
 # Overall title for pages.
-title: 'Lesson Title'
+title: 'Introduction to Version Control with Git and GitHub'
 
 # Date the lesson was created (YYYY-MM-DD, this is empty by default)
 created: '2026-04-29'
 
 # Comma-separated list of keywords for the lesson
-keywords: 'software, data, lesson, The Carpentries'
+keywords: 'lesson, The Carpentries, version control, git, github, Research Coding Club'
 
 # Life cycle stage of the lesson
 # refer to <https://docs.carpentries.org/resources/curriculum/lesson-life-cycle.html> for details
 # possible values: pre-alpha, alpha, beta, stable
-life_cycle: 'pre-alpha'
+life_cycle: 'stable'
 
 # License of the lesson materials (recommended CC-BY 4.0)
-license: 'CC-BY 4.0'
+license: 'CC-BY-SA 4.0'
 
 # Link to the source repository for this lesson
-source: 'https://example.com/template-source/lesson-example'
+source: 'https://github.com/ResearchCodingClub/intro-to-version-control'
 
 # Default branch of your lesson
 branch: 'main'
 
 # Who to contact if there are any issues
-contact: 'team@carpentries.org'
+contact: 'peter.hill@york.ac.uk'
 
 # Navigation ------------------------------------------------
 #
-# Use the following menu items to specify the order of
-# individual pages in each dropdown section. Leave blank to
-# include all pages in the folder.
-#
-# Example -------------
-#
-# episodes:
-# - introduction.md
-# - first-steps.md
-#
-# learners:
-# - setup.md
-#
-# instructors:
-# - instructor-notes.md
-#
-# profiles:
-# - one-learner.md
-# - another-learner.md
-
 # Order of episodes in your lesson
 episodes: 
-- introduction.Rmd
+- 00-introduction.md
+- 01-basics.md
 
 # Information for Learners
 learners: 
@@ -81,5 +62,5 @@ profiles:
 #
 # This space below is where custom yaml items (e.g. pinning
 # sandpaper and varnish versions) should live
-
-
+varnish: ResearchCodingClub/uoy-varnish@main
+url: 'https://researchcodingclub.github.io/intro-to-version-control/'

episodes/00-introduction.md

@@ -0,0 +1,76 @@
+---
+title: 'Introduction'
+teaching: 10
+exercises: 2
+---
+
+:::::::::::::::::::::::::::::::::::::: questions 
+
+- What are the goals of this course?
+
+::::::::::::::::::::::::::::::::::::::::::::::::
+
+::::::::::::::::::::::::::::::::::::: objectives
+
+- To understand the learning outcomees of this course
+- To understand the structure of the practicals
+
+::::::::::::::::::::::::::::::::::::::::::::::::
+
+# What is Version Control?
+
+Any means by which you track changes to something:
+
+![Is this effective version
+control?](fig/ineffective_version_control.png){alt="Four Python files named:
+work.py, work_final.py, work_final_2.py, work_final_2_really_final.py"}
+
+## What is Version Control?
+
+- Structured way of keeping track of changes to files
+- Implemented in different \"version control systems\" (VCS)
+- Typically share the concept of a history, the  changes which make up the history , and the ability to move freely back and forth within the history
+- The most popular VCS is  git , which we will be focusing on today
+
+## Why Version Control?
+
+- Keeps a labelled history of all changes made to a project, and lets you rewind them if something goes wrong
+- Lets you experiment with changes to a project whilst keeping stable versions of the project untouched
+- Provides lots of convenience features for working with other people on a project
+- Can act as a backup of your projects, especially when using a hosted service like GitHub
+- Many tools (like IDEs) have git integrations
+
+## What is git?
+
+- A specific version control system, created by the guy who created the Linux kernel (the myth goes that he named it by his personal reputation)
+- A \"distributed\" version control system - many people can have copies of the stuff under version control and they don't need to all be in sync
+- One of the most important programming tools you can benefit from becoming comfortable with
+
+![](fig/git_logo.png){alt="Git logo"}
+
+## What is GitHub?
+
+- A  service for hosting, organising, and collaborating on projects that are under version control
+
+<!-- -->
+
+- Other git services are available
+
+<!-- -->
+
+- Provides a consistent way to store and share version-controlled projects
+- Can act as a portfolio of sorts
+- Has a whole host of other features (project management, continuous integration, etc.)
+- See the  PlasmaFAIR GitHub organisation  for an example
+
+![](fig/github_logo.png){alt="GitHub logo"}
+
+## Git Glossary: Basics
+
+- Repository (repo) : a project under version control
+- History : timeline of changes to your repo
+- Clone : make a local copy of a repo, including its history
+- Commit : a labelled set of specific change to files in your repo
+- Push / pull : synchronise history with another copy of your repo
+- Working tree : the current state of your project and files on disk
+- Track : keep under version control