Skip to content

Commit

Permalink
[IMP] sale_order_pos_report_plain_text: Add readme.
Browse files Browse the repository at this point in the history
  • Loading branch information
Tiago370 committed Jan 10, 2025
1 parent cf91142 commit 4d42c22
Show file tree
Hide file tree
Showing 5 changed files with 493 additions and 24 deletions.
83 changes: 59 additions & 24 deletions sale_order_pos_report_plain_text/README.rst
Original file line number Diff line number Diff line change
@@ -1,35 +1,70 @@
**This file is going to be generated by oca-gen-addon-readme.**
=====================
Sale Order Pos Report
=====================

*Manual changes will be overwritten.*
..
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! This file is generated by oca-gen-addon-readme !!
!! changes will be overwritten. !!
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! source digest: sha256:44c05f30a11973109eaef8c10fb0682689406bf2433eb2b93a4eb916a1b0f44e
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
Please provide content in the ``readme`` directory:
.. |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-LGPL--3-blue.png
:target: http://www.gnu.org/licenses/lgpl-3.0-standalone.html
:alt: License: LGPL-3
.. |badge3| image:: https://img.shields.io/badge/github-KMEE%2Fkmee--odoo--addons-lightgray.png?logo=github
:target: https://github.com/KMEE/kmee-odoo-addons/tree/15.0/sale_order_pos_report_plain_text
:alt: KMEE/kmee-odoo-addons

* **DESCRIPTION.rst** (required)
* INSTALL.rst (optional)
* CONFIGURE.rst (optional)
* **USAGE.rst** (optional, highly recommended)
* DEVELOP.rst (optional)
* ROADMAP.rst (optional)
* HISTORY.rst (optional, recommended)
* **CONTRIBUTORS.rst** (optional, highly recommended)
* CREDITS.rst (optional)
|badge1| |badge2| |badge3|

Content of this README will also be drawn from the addon manifest,
from keys such as name, authors, maintainers, development_status,
and license.
POS report containing unformatted text in a new browser tab.

A good, one sentence summary in the manifest is also highly recommended.
**Table of contents**

.. contents::
:local:

Automatic changelog generation
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Usage
=====

`HISTORY.rst` can be auto generated using `towncrier <https://pypi.org/project/towncrier>`_.
To use this module, you need to:

Just put towncrier compatible changelog fragments into `readme/newsfragments`
and the changelog file will be automatically generated and updated when a new fragment is added.
#. Go to *Sales > Orders > Quotation*. #. Within a sales order. Click
the To **Print button**.

Please refer to `towncrier` documentation to know more.
Bug Tracker
===========

NOTE: the changelog will be automatically generated when using `/ocabot merge $option`.
If you need to run it manually, refer to `OCA/maintainer-tools README <https://github.com/OCA/maintainer-tools>`_.
Bugs are tracked on `GitHub Issues <https://github.com/KMEE/kmee-odoo-addons/issues>`_.
In case of trouble, please check there if your issue has already been reported.
If you spotted it first, help us to smash it by providing a detailed and welcomed
`feedback <https://github.com/KMEE/kmee-odoo-addons/issues/new?body=module:%20sale_order_pos_report_plain_text%0Aversion:%2015.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
-------

* KMEE

Contributors
------------

- ``KMEE <https://www.kmee.com.br>``\ \_:

- Tiago Amaral

Maintainers
-----------

This module is part of the `KMEE/kmee-odoo-addons <https://github.com/KMEE/kmee-odoo-addons/tree/15.0/sale_order_pos_report_plain_text>`_ project on GitHub.

You are welcome to contribute.
3 changes: 3 additions & 0 deletions sale_order_pos_report_plain_text/readme/CONTRIBUTORS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
* `KMEE <https://www.kmee.com.br>`_:

* Tiago Amaral
1 change: 1 addition & 0 deletions sale_order_pos_report_plain_text/readme/DESCRIPTION.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
POS report containing unformatted text in a new browser tab.
4 changes: 4 additions & 0 deletions sale_order_pos_report_plain_text/readme/USAGE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
To use this module, you need to:

#. Go to *Sales > Orders > Quotation*.
#. Within a sales order. Click the To **Print button**.
Loading

0 comments on commit 4d42c22

Please sign in to comment.