Skip to content

Commit

Permalink
Added link to src code documentation in README.md
Browse files Browse the repository at this point in the history
- Added link to read the docs.
- Added badges for Travis build and RTD status.
  • Loading branch information
adcroft authored Apr 19, 2017
1 parent 52f5fa0 commit 0574855
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
[![Build Status](https://travis-ci.org/NOAA-GFDL/MOM6.svg?branch=dev/master)](https://travis-ci.org/NOAA-GFDL/MOM6)
[![Read The Docs Status](https://readthedocs.org/projects/mom6/badge/?badge=latest)](http://mom6.readthedocs.io/)

# MOM6

This is the MOM6 source code.
Expand All @@ -6,6 +9,8 @@ This is the MOM6 source code.

Start at the [MOM6-examples wiki](https://github.com/NOAA-GFDL/MOM6-examples/wiki) which has installation instructions.

[Source code documentation](http://mom6.readthedocs.io/) is hosted on read the docs.

# What files are what

The top level directory structure groups source code and input files as follow:
Expand Down

0 comments on commit 0574855

Please sign in to comment.