Add Docker Compose file and update README

[CasperWA]

Closes #57

To see the updated README go here.

[sygout]

Looks nice. but 2 questions:

• it seems that the text is duplicated. why? it is possible to use a reference?
• sentence : " Note, remember to update setup.cfg to list the plugin strategies - otherwise they will not be findable by the OTEAPI service." is it specific to the service test or a generic remark for the plug-in development?

[CasperWA]

• it seems that the text is duplicated. why? it is possible to use a reference?

Which text do you mean explicitly?

• sentence : " Note, remember to update setup.cfg to list the plugin strategies - otherwise they will not be findable by the OTEAPI service." is it specific to the service test or a generic remark for the plug-in development?

This is how the plugin system works - so this is general.

[sygout]

text in these two files:
{{ cookiecutter.project_slug }}/docs/index.md
{{ cookiecutter.project_slug }}/README.md

"This is how the plugin system works - so this is general." then i would put it at the start of the Test the plugin section. So that it is more visible

Otherwise I see that a CI test if failing.

[CasperWA]

text in these two files: {{ cookiecutter.project_slug }}/docs/index.md {{ cookiecutter.project_slug }}/README.md

"This is how the plugin system works - so this is general." then i would put it at the start of the Test the plugin section. So that it is more visible

Otherwise I see that a CI test if failing.

Ah - the index.md file is generated from the README.md. Hence the similar text :)
One is essentially a copy of the other, with some tricks to fix the links.

[CasperWA]

Ah - the index.md file is generated from the README.md. Hence the similar text :) One is essentially a copy of the other, with some tricks to fix the links.

For more information on how this is done, see the pre-commit hooks config file and the associated invoke task.

Note that the latter has been updated in the current PR.