You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

92 lines
2.1 KiB

  1. .. image:: https://img.shields.io/badge/licence-AGPL--3-blue.svg
  2. :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
  3. :alt: License: AGPL-3
  4. ==============
  5. {module_title}
  6. ==============
  7. This module extends the functionality of ... to support ...
  8. and to allow you to ...
  9. Installation
  10. ============
  11. To install this module, you need to:
  12. #. Do this ...
  13. Configuration
  14. =============
  15. To configure this module, you need to:
  16. #. Go to ...
  17. .. figure:: path/to/local/image.png
  18. :alt: alternative description
  19. :width: 600 px
  20. Usage
  21. =====
  22. To use this module, you need to:
  23. #. Go to ...
  24. .. image:: https://odoo-community.org/website/image/ir.attachment/5784_f2813bd/datas
  25. :alt: Try me on Runbot
  26. :target: https://runbot.odoo-community.org/runbot/{repo_id}/{branch}
  27. .. repo_id is available in https://github.com/OCA/maintainer-tools/blob/master/tools/repos_with_ids.txt
  28. .. branch is "8.0" for example
  29. Known issues / Roadmap
  30. ======================
  31. * Add ...
  32. Bug Tracker
  33. ===========
  34. Bugs are tracked on `GitHub Issues
  35. <https://github.com/OCA/{project_repo}/issues>`_. In case of trouble, please
  36. check there if your issue has already been reported. If you spotted it first,
  37. help us smashing it by providing a detailed and welcomed feedback.
  38. Credits
  39. =======
  40. Images
  41. ------
  42. * Odoo Community Association: `Icon <https://github.com/OCA/maintainer-tools/blob/master/template/module/static/description/icon.svg>`_.
  43. Contributors
  44. ------------
  45. * Firstname Lastname <email.address@example.org>
  46. * Second Person <second.person@example.org>
  47. Funders
  48. -------
  49. The development of this module has been financially supported by:
  50. * Company 1 name
  51. * Company 2 name
  52. Maintainer
  53. ----------
  54. .. image:: https://odoo-community.org/logo.png
  55. :alt: Odoo Community Association
  56. :target: https://odoo-community.org
  57. This module is maintained by the OCA.
  58. OCA, or the Odoo Community Association, is a nonprofit organization whose
  59. mission is to support the collaborative development of Odoo features and
  60. promote its widespread use.
  61. To contribute to this module, please visit https://odoo-community.org.