Getting Started

GitHub

If you are new to GitHub, here are a couple good places to get started:

• https://guides.github.com/activities/hello-world/
• https://training.github.com/kit/foundations/

We have also made a pdf Github Online Editor Introduction that summarize the steps to edit files online.

SourceTree

Many of the developers in the group use SourceTree (https://www.sourcetreeapp.com/) as a desktop client for managing repositories. This tutorial is pretty good:

• http://www.bogotobogo.com/cplusplus/Git/Git_GitHub_Source_Tree_1_Commit_Push.php

Building the docs

Once you have cloned the repository, you will need sphinx to compile the pages. The easiest way is to download anaconda, which is a package manager for python:

https://www.continuum.io/downloads

Once you have downloaded it, you should be able to open a command window in the em folder and run:

make html

and have a local version of the website compile. It will be in the folder _build/html. The homepage is index.html. If you open up index.html in a web-browser, you will be able to view your current, local version of the website.

If you are have anaconda but are getting an error regarding the alabaster theme, try running

pip install --upgrade sphinx