climate-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From jo...@apache.org
Subject [2/4] git commit: CLIMATE-499 - Add doc building instructions to README
Date Mon, 04 Aug 2014 15:11:49 GMT
CLIMATE-499 - Add doc building instructions to README


Project: http://git-wip-us.apache.org/repos/asf/climate/repo
Commit: http://git-wip-us.apache.org/repos/asf/climate/commit/9854efa8
Tree: http://git-wip-us.apache.org/repos/asf/climate/tree/9854efa8
Diff: http://git-wip-us.apache.org/repos/asf/climate/diff/9854efa8

Branch: refs/heads/master
Commit: 9854efa85d971c0ba6cd330efa131c5101d3397d
Parents: 63fc51e
Author: Michael Joyce <joyce@apache.org>
Authored: Mon Aug 4 08:04:10 2014 -0700
Committer: Michael Joyce <joyce@apache.org>
Committed: Mon Aug 4 08:04:10 2014 -0700

----------------------------------------------------------------------
 README.md | 10 ++++++++++
 1 file changed, 10 insertions(+)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/climate/blob/9854efa8/README.md
----------------------------------------------------------------------
diff --git a/README.md b/README.md
index 7d27ebe..3241a36 100644
--- a/README.md
+++ b/README.md
@@ -11,3 +11,13 @@ There are a number of examples in the *examples* directory to help users
get sta
 ## Development
 
 OCW always welcomes pull request. Please check the [Developer Area](https://cwiki.apache.org/confluence/display/CLIMATE/Developer+Area)
on the wiki for additional information on how to contribute. The [project's JIRA](https://issues.apache.org/jira/browse/CLIMATE)
is a great place to start looking for issues to solve. Make sure to stop by the mailing lists
and introduce yourself as well!
+
+## Documentation
+
+If you would like to build the documentation for the project run the following command from
the root of the repository:
+
+```
+cd docs && make html
+```
+
+You will need to have installed the project dependencies first. Checkout the [Getting Started](https://cwiki.apache.org/confluence/display/CLIMATE/Getting+Started)
and [Easy OCW](https://cwiki.apache.org/confluence/display/CLIMATE/Easy-OCW+-+A+Guide+to+Simplifying+OCW+Installation)
pages for help getting the necessary dependencies installed.


Mime
View raw message