Use Cases / Context

[ This file is optional but strongly suggested to allow end-users to evaluate the module’s usefulness in their context. ]

BUSINESS NEED: It should explain the “why” of the module:

• what is the business requirement that generated the need to develop this module

• in which context or use cases this module can be useful (practical examples are welcome!).

APPROACH: It could also explain the approach to address the mentioned need.

USEFUL INFORMATION: It can also inform on related modules:

• modules it depends on and their features

• other modules that can work well together with this one

• suggested setups where the module is useful (eg: multicompany, multi-website)

Installation

[ 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:

1. Do this …

Configuration

[ This file is not always required; it should explain how to configure the module before using it; it is aimed at users with administration privileges.

Please be detailed on the path to configuration (eg: do you need to activate developer mode?), describe step by step configurations and the use of screenshots is strongly recommended.]

To configure this module, you need to:

• Go to App > Menu > Menu item

• Activate boolean… > save

• …

Usage

[ This file is required and contains the instructions on “how” to use the module for end-users.

If the module does not have a visible impact on the user interface, just add the following sentence:

This module does not impact the user interface.

If that’s not the case, please make sure that every usage step is covered and remember that images speak more than words!]

To use this module, you need to:

• Go to App > Menu > Menu item

  insert screenshot!

• In “Contact” form, add a value to field xyz > save

  insert screenshot!

• The value of xyz is now displayed in the list view.

  insert screenshot!

Known issues / Roadmap

[ 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. ]

• …

Changelog

[ 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. ]

Bug Tracker

Bugs are tracked on GitHub 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.

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

Credits

Maintainers

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.

This module is part of the OCA/wms project on GitHub.

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