Skip to content

Latest commit

 

History

History
33 lines (17 loc) · 2.71 KB

README.md

File metadata and controls

33 lines (17 loc) · 2.71 KB
Raw

GitHub Training Kit

This is the official courseware for the GitHub Training Team. This repository provides open source materials and slides for teaching GitHub Classes under the CC BY 3.0 license.

We know that part of effectively sharing GitHub and Git with the world goes beyond our team's course offerings. We are pleased to provide you with this training kit that you can use to teach these same concepts at your company, for a user group, or at a conference.

Download

We know that many of the users of this repository are just focused on getting the materials and teaching from them. We've made that easy.

  1. You can view and teach from the kit, hosted on GitHub, at http://training.github.com/kit
  2. You can download an offline copy of the kit via the green button at https://github.com/github/training-kit/releases

Contribute

We’re eager to have your help in improving this kit. If you have an idea for a change, start by opening a new Issue so we can discuss and help guide your contribution to the right location. If you have corrections or kit contributions, we'd be glad to receive them via a Pull Request. For kit contributions, we ask you to share in our mindset of minimalism. We aim to keep the workbook and slides a synchronized pair.

The educational content exists in two top level directories:

  1. slides
  2. workbooks

File Format

The majority of the site materials are written in Markdown, a lightweight markup language supported in the GitHub web application user interface. There is a syntax guide to the original Markdown format and also GitHub Flavored Markdown. This repository is based on Hydeslides. That project offers additional information on the file and directory structure.

Build

The build of this repository is fully automated through several shell scripts. To perform a build of the materials identical to that of our continuous integration server, from the top directory of this project, run ./_buildscripts/cibuild and then inspect the output in the _site directory.

The _buildscripts/makerelease script produces a zip bundle for offline use of these materials. Pre-built releases are available at https://github.com/github/training-kit/releases