[IMP] README based on example of README by OCA

pull/188/head
Francesco Apruzzese 2015-07-26 15:48:33 +02:00
parent ab19d4324f
commit ff61223e98
1 changed files with 34 additions and 1 deletions

View File

@ -1,3 +1,6 @@
.. image:: https://img.shields.io/badge/licence-AGPL--3-blue.svg
:alt: License: AGPL-3
Ribbon Test Environment
=======================
@ -6,6 +9,11 @@ Mark a Test Environment with a red ribbon on the top left corner in every page
.. image:: /ribbon_test_environment/static/description/screenshot.png
:alt: Screenshot
Installation
============
* No special setup
Configuration
=============
@ -16,10 +24,35 @@ Usage
To use this module, you need only to install it. After installation, a red ribbon will be visible on top left corner of every Odoo page
Bug Tracker
===========
Bugs are tracked on `GitHub Issues <https://github.com/OCA/web/issues>`_.
In case of trouble, please check there if your issue has already been reported.
If you spotted it first, help us smashing it by providing a detailed and welcomed feedback
`here <https://github.com/OCA/{project_repo}/issues/new?body=module:%20{module_name}%0Aversion:%20{version}%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
Credits
=======
Contributors
------------
* Francesco Apruzzese <cescoap@gmail.com>
* Francesco Apruzzese <cescoap@gmail.com>
Maintainer
----------
.. image:: https://odoo-community.org/logo.png
:alt: Odoo Community Association
:target: https://odoo-community.org
This module is maintained by the OCA.
OCA, or the Odoo Community Association, is a nonprofit organization whose
mission is to support the collaborative development of Odoo features and
promote its widespread use.
To contribute to this module, please visit http://odoo-community.org.