This repo contains the contents of umidocs, hosted at umidocs.readthedocs.io
This repository is the development website for the umi user guide. If you wish to contribute to the online documentation head over to the wiki.
The main project site is https://web.mit.edu/sustainabledesignlab/projects/umi/index.html.
You may report any issues by using the Issues tab located at the top of this page.
Contributions in the form of Pull Requests are always welcome. Prior to issuing a pull request, make sure your code follows the style guide and coding conventions.
These instructions cover running this project locally on both macOS and Windows so that you can preview changes before pushing them to ReadTheDocs.
First, using the command line, navigate somewhere safe and clone the repository.
git clone https://github.com/MITSustainableDesignLab/umidocs.git
If you are not comfortable using git on the command-line, then try GitHub for Mac and GitHub for Windows. There's also the git cheat sheet.
The master branch represents the Official version of the site. Changes to the master branch will be built by ReadTheDocs.org and deployed to http://umidocs.readthedocs.io.
The develop branch is the WIP (Work In Progress) version of the site. It will also be built by ReadTheDocs and deployed to http://umidocs.readthedocs.io/en/develop/. Use this branch to test out your changes before submitting a Pull Request to the master branch.
Once you have cloned or forked this repository and are able to build it locally, please read the following guides: