README.rst¶
Guidlines¶
.. image:: https://img.shields.io/badge/license-LGPL--3-blue.png
:target: https://www.gnu.org/licenses/lgpl
:alt: License: LGPL-3
===============
{MODULE_NAME}
===============
{Put some short introduction first.}
{Then add more detailed description, technical specifications, any other information that could be interested for other developers. Don't forget that Usage instructions is a separated and has to be located in doc/index.rst file.}
Credits
=======
Contributors
------------
* `{DEVELOPER_NAME} <https://it-projects.info/team/{DEVELOPER_GITHUB_USERNAME}>`__
Sponsors
--------
* `IT-Projects LLC <https://it-projects.info>`__
Maintainers
-----------
* `IT-Projects LLC <https://it-projects.info>`__
To get a guaranteed support
you are kindly requested to purchase the module
at `odoo apps store <https://apps.odoo.com/apps/modules/{VERSION}/{TECHNICAL_NAME}/>`__.
Thank you for understanding!
`IT-Projects Team <https://www.it-projects.info/team>`__
Further information
===================
Demo: http://runbot.it-projects.info/demo/{REPO_NAME}/{BRANCH}
HTML Description: https://apps.odoo.com/apps/modules/{VERSION}/{TECHNICAL_NAME}/
Usage instructions: `<doc/index.rst>`_
Changelog: `<doc/changelog.rst>`_
Notifications on updates: `via Atom <https://github.com/it-projects-llc/{REPO_NAME}/commits/{BRANCH}/{TECHNICAL_NAME}.atom>`_, `by Email <https://blogtrottr.com/?subscribe=https://github.com/it-projects-llc/{REPO_NAME}/commits/{BRANCH}/{TECHNICAL_NAME}.atom>`_
Tested on Odoo {VERSION} {ODOO_COMMIT_SHA_TO_BE_UPDATED}
Demo¶
Link to the runbot. Supported repo names are below. Change branche name if needed.
Demo: http://runbot.it-projects.info/demo/access-addons/10.0
Demo: http://runbot.it-projects.info/demo/addons-dev/misc-addons-10.0-some_feature
Demo: http://runbot.it-projects.info/demo/l10n-addons/10.0
Demo: http://runbot.it-projects.info/demo/mail-addons/10.0
Demo: http://runbot.it-projects.info/demo/misc-addons/10.0
Demo: http://runbot.it-projects.info/demo/odoo-saas-tools/10.0
Demo: http://runbot.it-projects.info/demo/odoo-telegram/10.0
Demo: http://runbot.it-projects.info/demo/pos-addons/10.0
Demo: http://runbot.it-projects.info/demo/rental-addons/10.0
Demo: http://runbot.it-projects.info/demo/website-addons/10.0
addons-dev¶
In most cases, if you work in addons-dev, you shall not use demo link to addons-dev (e.g. http://runbot.it-projects.info/demo/addons-dev/misc-addons-10.0-some_feature). Use a link for target repo instead (e.g. http://runbot.it-projects.info/demo/misc-addons/10.0).
You can use links to addons-dev only if you know who will use it.
HTML Description¶
Link to app store, e.g.
HTML Description: https://apps.odoo.com/apps/modules/10.0/web_debranding/
You have to prepare this link even if the module is not published yet, i.e. link returns 404 error.