diff --git a/README.md b/README.md index 3a75dd939..be8e2d1cf 100644 --- a/README.md +++ b/README.md @@ -26,32 +26,46 @@ These are the main playbooks: You may want to use the [anisble option "checkrun"](http://docs.ansible.com/playbooks_checkmode.html) to do a dry-run of the playbooks. With this option, Ansible will run the playbooks, but not actually make changes on the server. -## Requirements +## Setup -You will need to install Ansible, alongside other dependencies, on your machine to run the playbooks. You can do so with: +* Fork the ofn-install repository. +* Clone the forked copy: + ``` + git clone https://github.com//ofn-install.git + ``` -``` -pip install -r requirements.txt -``` +### Python -Before that, it's recommended you set up your Python environment using [Pyenv](https://github.com/pyenv/pyenv). - -In that case, you need to: +It's recommended you set up your Python environment using [Pyenv](https://github.com/pyenv/pyenv). * Install and configure [pyenv](https://github.com/pyenv/pyenv) * Install and configure [pyenv-virtualenv](https://github.com/pyenv/pyenv-virtualenv) * Install the required Python version: + ``` + $ pyenv install 3.8.2 + ``` +* Create the virtualenv: + ``` + $ pyenv virtualenv 3.8.2 ofn-install + ``` + +### Dependencies + +You will need to install Ansible, alongside other dependencies, on your machine to run the playbooks. You can do so with: ``` -$ pyenv install 3.8.2 +pip install -r requirements.txt ``` -* Create the virtualenv: +### Ansible Galaxy Roles + +Some playbooks require third-party roles, which are specified in `bin/requirements.yml`. You can install with the included script: ``` -$ pyenv virtualenv 3.8.2 ofn-install +$ bin/setup ``` + ## Code quality Run the [ansible-lint](https://github.com/willthames/ansible-lint) checks using: