Skip to content

Commit

Permalink
Update to README
Browse files Browse the repository at this point in the history
  • Loading branch information
samuelduchesne committed Sep 27, 2017
1 parent 5b49b9b commit f12bd34
Showing 1 changed file with 16 additions and 1 deletion.
17 changes: 16 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,17 @@
# umi Docs
This is an attempt at updating the umi documentation

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

This is the development site for the umi user guide.

Instructions for developers are available on the [wiki].

## Main project location

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/samuelduchesne/umidocs/issues) button.

Contributions in the form of [Pull Requests](https://github.com/samuelduchesne/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/lbl-srg/modelica-buildings/wiki/Style-Guide).

0 comments on commit f12bd34

Please sign in to comment.