Update README

This commit is contained in:
James Shubin
2015-12-29 01:45:26 -05:00
parent 39f7c305f1
commit 72a8027b7f

View File

@@ -1,6 +1,8 @@
# *mgmt*: This is: mgmt! # *mgmt*: This is: mgmt!
[![Build Status](https://secure.travis-ci.org/purpleidea/mgmt.png)](http://travis-ci.org/purpleidea/mgmt) [![Documentation](https://img.shields.io/docs/markdown.png)](DOCUMENTATION.md) [![IRC](https://img.shields.io/irc/%23mgmtconfig.png)](https://webchat.freenode.net/?channels=#mgmtconfig) [![Build Status](https://secure.travis-ci.org/purpleidea/mgmt.png)](http://travis-ci.org/purpleidea/mgmt)
[![Documentation](https://img.shields.io/docs/markdown.png)](DOCUMENTATION.md)
[![IRC](https://img.shields.io/irc/%23mgmtconfig.png)](https://webchat.freenode.net/?channels=#mgmtconfig)
## Documentation: ## Documentation:
Please see: [DOCUMENTATION.md](DOCUMENTATION.md) or [PDF](https://pdfdoc-purpleidea.rhcloud.com/pdf/https://github.com/purpleidea/mgmt/blob/master/DOCUMENTATION.md). Please see: [DOCUMENTATION.md](DOCUMENTATION.md) or [PDF](https://pdfdoc-purpleidea.rhcloud.com/pdf/https://github.com/purpleidea/mgmt/blob/master/DOCUMENTATION.md).
@@ -25,8 +27,9 @@ Please look in the [examples/](examples/) folder for usage. If none exist, pleas
* TODO * TODO
## Dependencies: ## Dependencies:
* golang (available in most distros) * golang (required, available in most distros)
* pandoc (for building a pdf of the documentation) * pandoc (optional, for building a pdf of the documentation)
* graphviz (optional, for building a visual representation of the graph)
## Patches: ## Patches:
We'd love to have your patch! Please send it by email, or as a pull request. We'd love to have your patch! Please send it by email, or as a pull request.