# README.rst

# Brand

This is a base addon for brand modules. It adds the brand object and its menu and define an abstract model to be inherited from branded objects.

Table of contents

- Usage
- Bug Tracker
- Credits
  - Authors
  - Contributors
  - Other credits
  - Maintainers

## Usage

To use this module, you need to:

1. Go to Settings > General Settings
2. Select the brand use level
3. Go to Settings > Users & Companies > Brands
4. Add a new brand
5. Install one of branding module (e.g. account_brand)
6. Based on your choice for the brand use level, you will see a new field added to the branded object

To make a branded object, you need to:

1. Inherit from the res.brand.mixin

       class YourModel(models.Model):
           _name = 'your.model'
           _inherit = ['your.model', 'res.brand.mixin']

2. Add the brand field to the object form or tree view. The mixin will add the brand use level field automatically to the view and set the modifiers to the brand field. This will define its visibility and if it’s required or not.

You can refer to the account_brand. for more details.

## 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

### Authors

- ACSONE SA/NV

### Contributors

- Souheil Bejaoui <souheil.bejaoui@acsone.eu>
- Obertix:
  - Vicent Cubells
- Ammar Officewala <aofficewala@opensourceintegrators.com>

### Other credits

- ACSONE SA/NV <https://www.acsone.eu>

### 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.

Current maintainer:

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

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