Skip to content

Commit

Permalink
Updated the ReadMe to include a little bit more info
Browse files Browse the repository at this point in the history
  • Loading branch information
samuelduchesne committed Apr 20, 2018
1 parent 2777730 commit 89fafd9
Showing 1 changed file with 25 additions and 2 deletions.
27 changes: 25 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

[![Documentation Status](http://readthedocs.org/projects/umidocs/badge/?version=latest)](http://umidocs.readthedocs.io/en/latest/?badge=latest)

*umidocs* is hosted at [umidocs.readthedocs.io](http://umidocs.readthedocs.io)
This repo contains the contents of *umidocs*, hosted at [umidocs.readthedocs.io](http://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](https://github.com/MITSustainableDesignLab/umidocs/wiki).

Expand All @@ -11,7 +11,30 @@ This repository is the development website for the *umi* user guide. If you wish
The main project site is http://www.urbanmodeling.net.

## Development and contribution to the documentation
You may report any issues with using the [Issues](https://github.com/MITSustainableDesignLab/umidocs/issues) button.
You may report any issues by using the [Issues](https://github.com/MITSustainableDesignLab/umidocs/issues) tab located at the top of this page.

Contributions in the form of [Pull Requests](https://github.com/MITSustainableDesignLab/umidocs/pulls) are always welcome.
Prior to issuing a pull request, make sure your code follows the [style guide and coding conventions](https://github.com/MITSustainableDesignLab/wiki/Style-Guide).

## Getting Started

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](https://mac.github.com/) and [GitHub for Windows](https://windows.github.com/). There's also the [git cheat sheet](https://services.github.com/on-demand/downloads/github-git-cheat-sheet.pdf).

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.

## Next Steps

Once you have cloned or forked this repository and are able to build it locally, please read the following guides:

- [Style guide and coding conventions](https://github.com/MITSustainableDesignLab/wiki/Style-Guide)

0 comments on commit 89fafd9

Please sign in to comment.