Skip to content

Commit

Permalink
Added build instructions to README
Browse files Browse the repository at this point in the history
  • Loading branch information
Michael Schwartz authored and Michael Schwartz committed Jun 14, 2014
1 parent 604ce5e commit 78ea7fb
Showing 1 changed file with 33 additions and 3 deletions.
36 changes: 33 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,34 @@
docs
====

OX Documentation
================

OX uses Mkdocs to generate documentation. For more information
see their website: http://www.mkdocs.org

To generate the documentation:

$ mkdocs build

This will create a directory called `site` which has the index.html
for viewing in your browser.

The home repository for this project is:

- [https://github.com/GluuFederation/docs](https://github.com/GluuFederation/docs)

If you would like to contribute documentation please post a message on
http://support.gluu.org




> License
>
> Copyright © 2014 Gluu, Inc.
>
> Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
>
> The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
>
> THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

0 comments on commit 78ea7fb

Please sign in to comment.