Skip to content

Commit

Permalink
readme
Browse files Browse the repository at this point in the history
  • Loading branch information
RPSJR committed Nov 23, 2023
1 parent 687db18 commit cf55b0e
Show file tree
Hide file tree
Showing 10 changed files with 13 additions and 71 deletions.
7 changes: 3 additions & 4 deletions fleet_vehicle_ownership/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -28,10 +28,9 @@ Fleet Vehicle Ownership

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

[ This file must be max 2-3 paragraphs, and is required. ]

This module extends the functionality of ... to support ... and to allow
you to ...
This module extends the functionality of fleet to support vehicle owner
data and to allow you to add vehicle ownership, linking partners to
vehicles

**Table of contents**

Expand Down
8 changes: 0 additions & 8 deletions fleet_vehicle_ownership/readme/CONFIGURE.md

This file was deleted.

19 changes: 7 additions & 12 deletions fleet_vehicle_ownership/readme/CONTEXT.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,9 @@
[ This file is optional but strongly suggested to allow end-users to evaluate the
module's usefulness in their context. ]
This is an extension of the 'fleet.vehicle' model in the Odoo framework.
It introduces a new field, 'owner_id', to track and associate the owner of a vehicle.

It should explain the “why” of the module:
Fields:
- owner_id: Many2one field linking to the 'res.partner' model. It represents the owner of the vehicle.

- in which context or use cases this module can be useful (practical examples are
welcome!).
- what is the business requirement that generated the need to develop this module

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)
Usage:
- This extension is particularly useful in scenarios where it's essential to associate each fleet vehicle with a specific owner.
- The 'owner_id' field can be utilized to establish relationships with partners in the 'res.partner' model, facilitating clear ownership tracking.
3 changes: 1 addition & 2 deletions fleet_vehicle_ownership/readme/CONTRIBUTORS.md
Original file line number Diff line number Diff line change
@@ -1,2 +1 @@
- Firstname Lastname <email.address@example.org> (optional company website url)
- Second Person <second.person@example.org> (optional company website url)
- Raimundo Junior <raimundopsjr@gmail.com>
7 changes: 0 additions & 7 deletions fleet_vehicle_ownership/readme/CREDITS.md

This file was deleted.

4 changes: 1 addition & 3 deletions fleet_vehicle_ownership/readme/DESCRIPTION.md
Original file line number Diff line number Diff line change
@@ -1,3 +1 @@
[ This file must be max 2-3 paragraphs, and is required. ]

This module extends the functionality of ... to support ... and to allow you to ...
This module extends the functionality of fleet to support vehicle owner data and to allow you to add vehicle ownership, linking partners to vehicles
17 changes: 0 additions & 17 deletions fleet_vehicle_ownership/readme/HISTORY.md

This file was deleted.

6 changes: 0 additions & 6 deletions fleet_vehicle_ownership/readme/INSTALL.md

This file was deleted.

5 changes: 0 additions & 5 deletions fleet_vehicle_ownership/readme/ROADMAP.md

This file was deleted.

8 changes: 1 addition & 7 deletions fleet_vehicle_ownership/readme/USAGE.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,3 @@
[ 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:

1. Go to ...
1. Go to the veichle form and associate an owner or go to the partner form and associate a vehicle.

0 comments on commit cf55b0e

Please sign in to comment.