# Crowbar Documentation README

_This is not the documentation you are looking for... it is a pointer to the real documentation._

## Looking for Crowbar Resources?

[The Crowbar website](https://crowbar.github.io) has links to all information and is our recommended starting place.

## Specific Crowbar Documentation

We track Crowbar documentation with the code so that we can track versions of documentation with the code.

Here are commonly requested references:

* [Getting Started Guide](https://github.com/crowbar/crowbar/blob/master/doc/gettingstarted.md)

> You may need to look in subdirectories under the links above for additional details.

## Background
Crowbar documentation is distributed into multiple places under the /doc directory of each Crowbar module (aka "barclamps").  When the modules are installed, Crowbar combines all the /doc directories into a master documentation set.  These directories are structured into subdirectories for general topics.  This structure is common across all barclamps in the [Crowbar project](https://github.com/crowbar/)

> Please, do NOT add documentation in locations besides /doc!  If necessary, expand this README to include pointers to important /doc information.


# Crowbar Documentation README

[![Reviewed by Hound](https://img.shields.io/badge/Reviewed_by-Hound-8E64B0.svg)](https://houndci.com)

_This is not the documentation you are looking for... it is a pointer to the real documentation._

## Looking for Crowbar Resources?

[The Crowbar website](https://crowbar.github.io) has links to all information and is our recommended starting place.

## Specific Crowbar Documentation

We track Crowbar documentation with the code so that we can track versions of documentation with the code.

Here are commonly requested references:

* [Getting Started Guide](https://github.com/crowbar/crowbar/blob/master/doc/gettingstarted.md)

> You may need to look in subdirectories under the links above for additional details.

## Background
Crowbar documentation is distributed into multiple places under the /doc directory of each Crowbar module (aka "barclamps").  When the modules are installed, Crowbar combines all the /doc directories into a master documentation set.  These directories are structured into subdirectories for general topics.  This structure is common across all barclamps in the [Crowbar project](https://github.com/crowbar/)

> Please, do NOT add documentation in locations besides /doc!  If necessary, expand this README to include pointers to important /doc information.


Add a "Reviewed by Hound" badge
Add a "Reviewed by Hound" badge

What do you think about adding a Hound badge?