# Ansible role README generator

**URL:** <https://forum.ansible.com/t/ansible-role-readme-generator/31436>\
**Category:** Ansible Project\
**Created:** [October 8, 2019, 2:09pm UTC](https://forum.ansible.com/t/ansible-role-readme-generator/31436 "2019-10-08T14:09:13Z")\
**Posts on this page:** 2\
**Page:** 1

<div class="post-metadata">

**Author:** ![Nick\_Kakouros](https://avatars.discourse-cdn.com/v4/letter/n/d26b3c/32.png) [@Nick\_Kakouros](https://forum.ansible.com/u/Nick_Kakouros)\
**Post date:** [October 8, 2019, 2:09pm UTC](https://forum.ansible.com/t/ansible-role-readme-generator/31436/1 "2019-10-08T14:09:13Z")

</div>

I think I have seen at some point a role that used a yaml array to specify the contents of the REAMDE. That’s all I remember. In any case, are there tools to automatically generate a README for a role or based on a template of some sort? Has anyone used anything?

---

<div class="post-metadata">

**Author:** ![vbotka](https://sea1.discourse-cdn.com/ansible/user_avatar/forum.ansible.com/vbotka/32/359_2.png) [@vbotka](https://forum.ansible.com/u/vbotka)\
**Post date:** [October 8, 2019, 3:11pm UTC](https://forum.ansible.com/t/ansible-role-readme-generator/31436/2 "2019-10-08T15:11:40Z")

</div>

It's possible to initialise a role including the README.md template. For  
example

&nbsp;&nbsp;$ ansible-galaxy init my\_test\_role