Skip to content

Commit

Permalink
[UPD] README.rst
Browse files Browse the repository at this point in the history
  • Loading branch information
OCA-git-bot committed Oct 10, 2018
1 parent 2166786 commit 73e4943
Show file tree
Hide file tree
Showing 2 changed files with 494 additions and 22 deletions.
74 changes: 52 additions & 22 deletions project_description/README.rst
Original file line number Diff line number Diff line change
@@ -1,14 +1,38 @@
.. image:: https://img.shields.io/badge/licence-AGPL--3-blue.png
:target: https://www.gnu.org/licenses/agpl
:alt: License: AGPL-3

===================
Project Description
===================

.. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! This file is generated by oca-gen-addon-readme !!
!! changes will be overwritten. !!
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
:target: https://odoo-community.org/page/development-status
:alt: Beta
.. |badge2| image:: https://img.shields.io/badge/licence-AGPL--3-blue.png
:target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
:alt: License: AGPL-3
.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fproject-lightgray.png?logo=github
:target: https://github.com/OCA/project/tree/12.0/project_description
:alt: OCA/project
.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
:target: https://translation.odoo-community.org/projects/project-12-0/project-12-0-project_description
:alt: Translate me on Weblate
.. |badge5| image:: https://img.shields.io/badge/runbot-Try%20me-875A7B.png
:target: https://runbot.odoo-community.org/runbot/140/12.0
:alt: Try me on Runbot

|badge1| |badge2| |badge3| |badge4| |badge5|

This module extends the functionality of projects to support setting a
description for each project and allow you to search by that description.

**Table of contents**

.. contents::
:local:

Usage
=====

Expand All @@ -18,7 +42,7 @@ To set a description for a project, you need to:
#. Edit or create one.
#. You will see a new *Description* tab, with an HTML area to set the project's description.

.. figure:: static/description/image.png
.. figure:: https://raw.githubusercontent.com/OCA/project/12.0/project_description/static/description/image.png
:alt: Project form with the description tab

To search for a project by its description, you need to:
Expand All @@ -27,39 +51,45 @@ To search for a project by its description, you need to:
#. Enter any word in the search box.
#. Select *Search Description*.

.. image:: https://odoo-community.org/website/image/ir.attachment/5784_f2813bd/datas
:alt: Try me on Runbot
:target: https://runbot.odoo-community.org/runbot/140/12.0

Bug Tracker
===========

Bugs are tracked on `GitHub Issues
<https://github.com/OCA/project/issues>`_. In case of trouble, please
check there if your issue has already been reported. If you spotted it first,
help us smash it by providing detailed and welcomed feedback.
Bugs are tracked on `GitHub Issues <https://github.com/OCA/project/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 <https://github.com/OCA/project/issues/new?body=module:%20project_description%0Aversion:%2012.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.

Do not contact contributors directly about support or help with technical issues.

Credits
=======

Authors
~~~~~~~

* Tecnativa
* C2i Change 2 improve

Contributors
------------
~~~~~~~~~~~~

* Rafael Blasco <rafael.blasco@tecnativa.com> (Tecnativa https://www.tecnativa.com)
* Jairo Llopis <jairo.llopis@tecnativa.com> (Tecnativa https://www.tecnativa.com)
* Eduardo Magdalena <emagdalena@c2i.es> (C2i Change 2 improve http://www.c2i.es)

* Tecnativa (https://www.tecnativa.com): Rafael Blasco <rafael.blasco@tecnativa.com>
* Tecnativa (https://www.tecnativa.com): Jairo Llopis <jairo.llopis@tecnativa.com>
* C2i Change 2 improve (http://close2circle.com): Eduardo Magdalena <emagdalena@c2i.es>
Maintainers
~~~~~~~~~~~

Maintainer
----------
This module is maintained by the OCA.

.. 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 https://odoo-community.org.
This module is part of the `OCA/project <https://github.com/OCA/project/tree/12.0/project_description>`_ project on GitHub.

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.
Loading

0 comments on commit 73e4943

Please sign in to comment.