From 492ffbd50b8795acacacf1cd24026b809d0c2da6 Mon Sep 17 00:00:00 2001 From: Maciej Delmanowski Date: Sun, 5 Oct 2014 20:19:33 +0200 Subject: [PATCH] Replace Markdown README with reStructuredText README --- README.md => README.rst | 75 ++++++++++++++++++++++------------------- 1 file changed, 41 insertions(+), 34 deletions(-) rename README.md => README.rst (77%) diff --git a/README.md b/README.rst similarity index 77% rename from README.md rename to README.rst index 1f6a2e0..7047582 100644 --- a/README.md +++ b/README.rst @@ -1,46 +1,56 @@ +|DebOps| dhcpd +############## -## [![DebOps project](http://debops.org/images/debops-small.png)](http://debops.org) dhcpd +.. |DebOps| image:: http://debops.org/images/debops-small.png + :target: http://debops.org + +|Travis CI| |test-suite| |Ansible Galaxy| + +.. |Travis CI| image:: http://img.shields.io/travis/debops/ansible-dhcpd.svg?style=flat + :target: http://travis-ci.org/debops/ansible-dhcpd + +.. |test-suite| image:: http://img.shields.io/badge/test--suite-ansible--dhcpd-blue.svg?style=flat + :target: https://github.com/debops/test-suite/tree/master/ansible-dhcpd/ + +.. |Ansible Galaxy| image:: http://img.shields.io/badge/galaxy-debops.dhcpd-660198.svg?style=flat + :target: https://galaxy.ansible.com/list#/roles/1559 -[![Travis CI](http://img.shields.io/travis/debops/ansible-dhcpd.svg?style=flat)](http://travis-ci.org/debops/ansible-dhcpd) [![test-suite](http://img.shields.io/badge/test--suite-ansible--dhcpd-blue.svg?style=flat)](https://github.com/debops/test-suite/tree/master/ansible-dhcpd/) [![Ansible Galaxy](http://img.shields.io/badge/galaxy-debops.dhcpd-660198.svg?style=flat)](https://galaxy.ansible.com/list#/roles/1559) [![Platforms](http://img.shields.io/badge/platforms-debian%20|%20ubuntu-lightgrey.svg?style=flat)](#) +Install and configure `ISC DHCP Server`_. +.. _ISC DHCP Server: https://www.isc.org/downloads/dhcp/ +Installation +~~~~~~~~~~~~ +This role requires at least Ansible ``v1.7.0``. To install it, run: - - -Install and configure [ISC DHCP Server](https://www.isc.org/downloads/dhcp/). - - - - - -### Installation - -This role requires at least Ansible `v1.7.0`. To install it, run: +:: ansible-galaxy install debops.dhcpd -#### Are you using this as a standalone role without DebOps? +Are you using this as a standalone role without DebOps? +======================================================= -You may need to include missing roles from the [DebOps common -playbook](https://github.com/debops/debops-playbooks/blob/master/playbooks/common.yml) +You may need to include missing roles from the `DebOps common playbook`_ into your playbook. -[Try DebOps now](https://github.com/debops/debops) for a complete solution to run your Debian-based infrastructure. +`Try DebOps now`_ for a complete solution to run your Debian-based infrastructure. + +.. _DebOps common playbook: https://github.com/debops/debops-playbooks/blob/master/playbooks/common.yml +.. _Try DebOps now: https://github.com/debops/debops/ - - - - -### Role variables +Role variables +~~~~~~~~~~~~~~ List of default variables available in the inventory: +:: + --- # ---- Global ISC DHCP Server configuration ---- @@ -207,21 +217,18 @@ List of default variables available in the inventory: +Authors and license +~~~~~~~~~~~~~~~~~~~ +``dhcpd`` role was written by: +- Maciej Delmanowski | `e-mail `_ | `Twitter `_ | `GitHub `_ +License: `GPLv3 `_ +**** -### Authors and license +This role is part of the `DebOps`_ project. README generated by `ansigenome`_. -`dhcpd` role was written by: - -- Maciej Delmanowski | [e-mail](mailto:drybjed@gmail.com) | [Twitter](https://twitter.com/drybjed) | [GitHub](https://github.com/drybjed) - -License: [GPLv3](https://tldrlegal.com/license/gnu-general-public-license-v3-%28gpl-3%29) - - - -*** - -This role is part of the [DebOps](http://debops.org/) project. README generated by [ansigenome](https://github.com/nickjj/ansigenome/). +.. _DebOps: http://debops.org/ +.. _Ansigenome: https://github.com/nickjj/ansigenome/