Plan for Software Carpentry 2012 Boot Camp on Version Control¶

Purpose¶

To explain version control to researchers who have never used it before, or who want to understand it better.

Context¶

Two hour interactive live workshop, using EasyMercurial and the Mercurial command-line tool.

Outline¶

The basic plan is:

1. presentation introduction to version control in general (using either whiteboard drawings or a PowerPoint presentation)
2. long worked example in which basic topics of version control are worked through using EasyMercurial and then some more advanced topics are returned to using the command-line tool
3. closing remarks talking about other tools, other topics of interest etc

Detailed outline:

• A presentation introduction to the concept of version control.
  • What is it for and why is it useful?
  • What can go wrong without it?
  • How does a version control system work?
  • History + Collaboration
• Check that participants have EasyMercurial installed and working
• Worked example, part 1: Working by myself
  • Topics: Initialising a repository, committing files, reading history, looking at diffs, reverting unwanted changes, going back in time to look at old versions
  • We will be working on a recipe for fish stew for a future recipe book
  • Make a new directory, create a text file fishstew.txt in it, start adding an ingredients list, save
  • Run up EasyMercurial, "Open" that directory, see fishstew.txt in untracked file list, explain this
  • Add file, commit, supply a message, note that we now have some history