diff --git a/README.md b/README.md index 44be5c0..6f407d8 100644 --- a/README.md +++ b/README.md @@ -4,9 +4,13 @@ Project directory structure templates for the Python Cookiecutter package. ## What's Cookiecutter? -The Python package [Cookiecutter](https://github.com/cookiecutter/cookiecutter) assists in creating directory structure for whatever purpose you need such as for example a new Python project, an Ansible role or a `docker-compose` project. If you've ever wanted to put project structure best practices into version control Cookiecutter's here to help. +The Python package [Cookiecutter](https://github.com/cookiecutter/cookiecutter) assists in creating directory structure for whatever purpose you need such as for example a new Python project, an Ansible role or a `docker-compose` project - anything really that benefits from a unifirm reproducible directory structure. If you've ever wanted to put project structure best practices into version control then Cookiecutter's here to help. -Cookiecutter is governed by so-called Cookiecutter templates. Most of its magic inside Cookiecutter templates happens via the [Jinja2 template engine](https://palletsprojects.com/p/jinja/) so if you're familiar with Ansible you'll feel right at home. +Cookiecutter is governed by so-called Cookiecutter templates, most of its magic inside Cookiecutter templates happens via the [Jinja2 template engine](https://palletsprojects.com/p/jinja/). You'll feel right at home if you're familiar with Ansible. + +## Repo layout + +Each subdirectory in this repo is a Cookiecutter template, you'll recognize them from their telltale `cookiecutter.json` files. Directories usually also have a readme file explaining more about each individual template. ## Get started @@ -24,7 +28,9 @@ Cookiecutter prompts you for whatever info the template needs then generates fil This is Cookiecutter prompting for info: ``` -info +service []: grafana +component_list [grafana]: grafana,nginx +context []: cncf ``` The end result is a directory structure that has everything you need to hit the ground running. @@ -50,5 +56,3 @@ The end result is a directory structure that has everything you need to hit the └── env └── fully.qualified.domain.name.example ``` - -Each subdirectory in this repo is a Cookiecutter template, you'll recognize them from their telltale `cookiecutter.json` files. Directories usually have a readme file explaining a bit more about each individual template.