Browse Source

README: improve markdown formatting

Rodolfo Carvalho 8 years ago
parent
commit
ac42a0bb8c
1 changed files with 11 additions and 8 deletions
  1. 11 8
      README.md

+ 11 - 8
README.md

@@ -1,13 +1,13 @@
 [![Join the chat at https://gitter.im/openshift/openshift-ansible](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/openshift/openshift-ansible)
 
-#OpenShift Ansible
+# OpenShift Ansible
 
 This repo contains Ansible code for OpenShift. This repo and the origin RPMs
 that it installs currently require a package that provides `docker`. Currently
 the RPMs provided from dockerproject.org do not provide this requirement, though
 they may in the future.
 
-##Branches and tags
+## Branches and tags
 
 The master branch tracks our current work and should be compatible with both
 Origin master branch and the most recent Origin stable release. Currently that's
@@ -20,22 +20,24 @@ Releases are tagged periodically from active branches and are versioned 3.x
 corresponding to Origin releases 1.x. We unfortunately started with 3.0 and it's
 not practical to start over at 1.0.
 
-##Setup
+## Setup
+
 - Install base dependencies:
   - Requirements:
     - Ansible >= 2.1.0 though 2.2 is preferred for performance reasons.
     - Jinja >= 2.7
 
   - Fedora:
-  ```
+    ```
     dnf install -y ansible-2.1.0.0 pyOpenSSL python-cryptography
-  ```
+    ```
 
   - OSX:
-  ```
+    ```
     # Install ansible 2.1.0.0 and python 2
     brew install ansible python
-  ```
+    ```
+
 - Setup for a specific cloud:
   - [AWS](http://github.com/openshift/openshift-ansible/blob/master/README_AWS.md)
   - [GCE](http://github.com/openshift/openshift-ansible/blob/master/README_GCE.md)
@@ -57,7 +59,8 @@ not practical to start over at 1.0.
   - [playbooks/](https://github.com/openshift/openshift-ansible/tree/master/playbooks) - houses host-type Ansible playbooks (launch, config, destroy, vars)
   - [roles/](https://github.com/openshift/openshift-ansible/tree/master/roles) - shareable Ansible tasks
 
-##Contributing
+## Contributing
+
 - [Best Practices Guide](https://github.com/openshift/openshift-ansible/blob/master/docs/best_practices_guide.adoc)
 - [Core Concepts](https://github.com/openshift/openshift-ansible/blob/master/docs/core_concepts_guide.adoc)
 - [Style Guide](https://github.com/openshift/openshift-ansible/blob/master/docs/style_guide.adoc)