joseerodrigues / training-materials

Open source outlines, slides, and cheat sheet courseware for teaching GitHub classes

GitHub Training Materials

This is the official courseware for the GitHub Training Team. This repository provides open source outlines, slides, and cheat sheets 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 excited to provide you with training materials that you can also use to teach these same concepts at your company, for a user group, or even 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 materials, hosted on GitHub, at http://training.github.com/materials
2. You can download an offline copy of the materials via the green button at https://github.com/github/training-materials/releases

Contribute

We’re eager to have your help in improving these materials. 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 materials contributions, we'd be glad to receive them via a Pull Request. For materials contributions, we ask you to share in our mindset of minimalism. We aim to keep the outlines, slides, and cheat sheets as synchronized triads.

The educational content exists in three top level directories:

1. outlines
2. slides
3. cheatsheets

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.

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-materials/releases