Skip to content

Commit 633e75e

Browse files
committed
[UPD] README.rst
1 parent bad244c commit 633e75e

File tree

2 files changed

+580
-16
lines changed

2 files changed

+580
-16
lines changed

fieldservice/README.rst

Lines changed: 117 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,122 @@
1-
**This file is going to be generated by oca-gen-addon-readme.**
1+
=============
2+
Field Service
3+
=============
24

3-
*Manual changes will be overwritten.*
5+
.. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
6+
!! This file is generated by oca-gen-addon-readme !!
7+
!! changes will be overwritten. !!
8+
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
49
5-
Please provide content in the ``readme`` directory:
10+
.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
11+
:target: https://odoo-community.org/page/development-status
12+
:alt: Beta
13+
.. |badge2| image:: https://img.shields.io/badge/licence-AGPL--3-blue.png
14+
:target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
15+
:alt: License: AGPL-3
16+
.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Ffield--service-lightgray.png?logo=github
17+
:target: https://github.com/OCA/field-service/tree/11.0/fieldservice
18+
:alt: OCA/field-service
19+
.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
20+
:target: https://translation.odoo-community.org/projects/field-service-11-0/field-service-11-0-fieldservice
21+
:alt: Translate me on Weblate
22+
.. |badge5| image:: https://img.shields.io/badge/runbot-Try%20me-875A7B.png
23+
:target: https://runbot.odoo-community.org/runbot/264/11.0
24+
:alt: Try me on Runbot
625

7-
* **DESCRIPTION.rst** (required)
8-
* INSTALL.rst (optional)
9-
* CONFIGURE.rst (optional)
10-
* **USAGE.rst** (optional, highly recommended)
11-
* DEVELOP.rst (optional)
12-
* ROADMAP.rst (optional)
13-
* HISTORY.rst (optional, recommended)
14-
* **CONTRIBUTORS.rst** (optional, highly recommended)
15-
* CREDITS.rst (optional)
26+
|badge1| |badge2| |badge3| |badge4| |badge5|
1627

17-
Content of this README will also be drawn from the addon manifest,
18-
from keys such as name, authors, maintainers, development_status,
19-
and license.
28+
This module is the base of the Field Service application in Odoo.
2029

21-
A good, one sentence summary in the manifest is also highly recommended.
30+
**Table of contents**
31+
32+
.. contents::
33+
:local:
34+
35+
Installation
36+
============
37+
38+
You need to install:
39+
40+
* PostGIS
41+
42+
Configuration
43+
=============
44+
45+
To configure this module, you need to:
46+
47+
* Go to Field Service > Configuration > Settings
48+
49+
Usage
50+
=====
51+
52+
To use this module, you need to:
53+
54+
* Go to Field Service
55+
* Create or select an order
56+
* Follow the process
57+
58+
Known issues / Roadmap
59+
======================
60+
61+
The roadmap of the Field Service application is documented on
62+
`Github <https://github.com/OCA/field-service/issues/1>`_.
63+
64+
Bug Tracker
65+
===========
66+
67+
Bugs are tracked on `GitHub Issues <https://github.com/OCA/field-service/issues>`_.
68+
In case of trouble, please check there if your issue has already been reported.
69+
If you spotted it first, help us smashing it by providing a detailed and welcomed
70+
`feedback <https://github.com/OCA/field-service/issues/new?body=module:%20fieldservice%0Aversion:%2011.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
71+
72+
Do not contact contributors directly about support or help with technical issues.
73+
74+
Credits
75+
=======
76+
77+
Authors
78+
~~~~~~~
79+
80+
* Open Source Integrators
81+
82+
Contributors
83+
~~~~~~~~~~~~
84+
85+
* Wolfgang Hall <[email protected]>
86+
* Maxime Chambreuil <[email protected]>
87+
* Steve Campbell <[email protected]>
88+
89+
Other credits
90+
~~~~~~~~~~~~~
91+
92+
The development of this module has been financially supported by:
93+
94+
* Open Source Integrators <https://opensourceintegrators.com>
95+
96+
Maintainers
97+
~~~~~~~~~~~
98+
99+
This module is maintained by the OCA.
100+
101+
.. image:: https://odoo-community.org/logo.png
102+
:alt: Odoo Community Association
103+
:target: https://odoo-community.org
104+
105+
OCA, or the Odoo Community Association, is a nonprofit organization whose
106+
mission is to support the collaborative development of Odoo features and
107+
promote its widespread use.
108+
109+
.. |maintainer-wolfhall| image:: https://github.com/wolfhall.png?size=40px
110+
:target: https://github.com/wolfhall
111+
:alt: wolfhall
112+
.. |maintainer-max3903| image:: https://github.com/max3903.png?size=40px
113+
:target: https://github.com/max3903
114+
:alt: max3903
115+
116+
Current `maintainers <https://odoo-community.org/page/maintainer-role>`__:
117+
118+
|maintainer-wolfhall| |maintainer-max3903|
119+
120+
This module is part of the `OCA/field-service <https://github.com/OCA/field-service/tree/11.0/fieldservice>`_ project on GitHub.
121+
122+
You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

0 commit comments

Comments
 (0)