Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README for open source #212

Merged
merged 10 commits into from
Jun 11, 2020
18 changes: 17 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,19 @@

[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-v2.0%20adopted-ff69b4.svg)](code_of_conduct.md)

Welcome to the GitHub Training Manual repo. In this repo, you will find the content used by GitHub trainers during our official training courses and scripts used when teaching.
Welcome to the GitHub Training Manual repository. In this repository, you will find the content used by GitHub trainers during our official GitHub training courses and the scripts used when teaching.
parkerbxyz marked this conversation as resolved.
Show resolved Hide resolved

The content is all written in [markdown](https://github.github.com/gfm/), and the scripts are shell scripts.
parkerbxyz marked this conversation as resolved.
Show resolved Hide resolved

## Technologies used

This manual is served using GitHub Pages and [docsify](https://docsify.js.org), and can be found at [githubtraining.github.io/training-manual](https://githubtraining.github.io/training-manual/#/).
parkerbxyz marked this conversation as resolved.
Show resolved Hide resolved

## Goals and scope

The goal of this project is to serve as a content source for training on Git and GitHub. While GitHub, select GitHub Partners, and select customers may have their own use case directly with GitHub, the content is open source so we can share and improve as a community. You can find more information on contributing in the [contributing guide](CONTRIBUTING.md).

The topic scope is limited to GitHub's core product features, on GitHub.com and also for GitHub Enterprise users.

## Deploy the manual

Expand Down Expand Up @@ -52,3 +64,7 @@ Docsify doesn't currently support creating PDFs, but you can generate one using
## Teaching scripts

Scripts that accompany the manual, and their documentation can be found in the [`script/`](script/) directory.

## License

Please see the [license](LICENSE) for detailed information. When using the GitHub logos, be sure to follow the [GitHub logo guidelines](https://github.com/logos).
parkerbxyz marked this conversation as resolved.
Show resolved Hide resolved