Skip to content

Commit

Permalink
[NEW] README files
Browse files Browse the repository at this point in the history
Signed-off-by: Luis Felipe Mileo <[email protected]>

Signed-off-by: Luis Felipe Mileo <[email protected]>
  • Loading branch information
mileo committed Feb 6, 2020
1 parent 0b46222 commit 2dcee7f
Show file tree
Hide file tree
Showing 9 changed files with 71 additions and 71 deletions.
71 changes: 0 additions & 71 deletions README.md

This file was deleted.

10 changes: 10 additions & 0 deletions l10n_br_account_payment_cobranca/readme/CONFIGURE.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
[ This file is optional, it should explain how to configure
the module before using it; it is aimed at advanced users. ]

To configure this module, you need to:

#. Go to ...

.. figure:: ../static/description/image.png
:alt: alternative description
:width: 600 px
2 changes: 2 additions & 0 deletions l10n_br_account_payment_cobranca/readme/CONTRIBUTORS.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
* Firstname Lastname <[email protected]> (optional company website url)
* Second Person <[email protected]> (optional company website url)
7 changes: 7 additions & 0 deletions l10n_br_account_payment_cobranca/readme/CREDITS.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
[ This file is optional and contains additional credits, other than
authors, contributors, and maintainers. ]

The development of this module has been financially supported by:

* Company 1 name
* Company 2 name
5 changes: 5 additions & 0 deletions l10n_br_account_payment_cobranca/readme/DESCRIPTION.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
[ This file must be max 2-3 paragraphs, and is required. ]

This module extends the functionality of portal to support Brasilian
fields.

24 changes: 24 additions & 0 deletions l10n_br_account_payment_cobranca/readme/HISTORY.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
[ The change log. The goal of this file is to help readers
understand changes between version. The primary audience is
end users and integrators. Purely technical changes such as
code refactoring must not be mentioned here.

This file may contain ONE level of section titles, underlined
with the ~ (tilde) character. Other section markers are
forbidden and will likely break the structure of the README.rst
or other documents where this fragment is included. ]

11.0.x.y.z (YYYY-MM-DD)
~~~~~~~~~~~~~~~~~~~~~~~

* [BREAKING] Breaking changes come first.
(`#70 <https://github.com/OCA/repo/issues/70>`_)
* [ADD] New feature.
(`#74 <https://github.com/OCA/repo/issues/74>`_)
* [FIX] Correct this.
(`#71 <https://github.com/OCA/repo/issues/71>`_)

11.0.x.y.z (YYYY-MM-DD)
~~~~~~~~~~~~~~~~~~~~~~~

* ...
7 changes: 7 additions & 0 deletions l10n_br_account_payment_cobranca/readme/INSTALL.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
[ This file must only be present if there are very specific
installation instructions, such as installing non-python
dependencies. The audience is systems administrators. ]

To install this module, you need to:

#. Do this ...
5 changes: 5 additions & 0 deletions l10n_br_account_payment_cobranca/readme/ROADMAP.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
[ Enumerate known caveats and future potential improvements.
It is mostly intended for end-users, and can also help
potential new contributors discovering new features to implement. ]

* ...
11 changes: 11 additions & 0 deletions l10n_br_account_payment_cobranca/readme/USAGE.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
[ This file must be present and contains the usage instructions
for end-users. As all other rst files included in the README,
it MUST NOT contain reStructuredText sections
only body text (paragraphs, lists, tables, etc). Should you need
a more elaborate structure to explain the addon, please create a
Sphinx documentation (which may include this file as a "quick start"
section). ]

To use this module, you need to:

#. Go to ...

0 comments on commit 2dcee7f

Please sign in to comment.