audrius/pms
1
0
Fork 1
mirror of https://github.com/OCA/pms.git synced 2025-01-29 00:17:45 +02:00
Code Issues Packages Projects Releases Wiki Activity

[ADD] readme files structure for future oca-gen-addon-readme

Browse Source
This commit is contained in:
Pablo
2019-09-27 08:25:31 +02:00
parent dc77037053
commit 036e661e80
8 changed files with 32 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
hotel/README.rst
View File

@@ -19,7 +19,7 @@ and ``account_cancel``. Ensure yourself to have all them in your addons list.
Configuration
-------------
You will find the hotel calendar in `Settings > Users & Companies > Hotels > Your Hotel.
You will find the hotel settings in `Settings > Users & Companies > Hotels > Your Hotel.
This module required additional configuration for company, accounting, invoicing and user privileges.

6
hotel/readme/CONFIGURE.rst Normal file
View File

@@ -0,0 +1,6 @@
.. [ This file is optional, it should explain how to configure
the module before using it; it is aimed at advanced users. ]
You will find the hotel settings in `Settings > Users & Companies > Hotels > Your Hotel.
This module required additional configuration for company, accounting, invoicing and user privileges.

1
hotel/readme/CONTRIBUTORS.rst Normal file
View File

@@ -0,0 +1 @@
.. authors are taken from the __manifest__.py file

2
hotel/readme/CREDITS.rst Normal file
View File

@@ -0,0 +1,2 @@
.. [ This file is optional and contains additional credits, other than
authors, contributors, and maintainers. ]

7
hotel/readme/DESCRIPTION.rst Normal file
View File

@@ -0,0 +1,7 @@
.. [ This file must be max 2-3 paragraphs, and is required. ]
This module is an all-in-one property management system (PMS) focused on medium-sized hotels
for managing every aspect of your property's daily operations.
You can manage hotel properties with multi-hotel and multi-company support, including your rooms inventory,
reservations, check-in, daily reports, board services, rate and restriction plans among other hotel functionalities.

5
hotel/readme/INSTALL.rst Normal file
View File

@@ -0,0 +1,5 @@
.. [ This file must only be present if there are very specific
installation instructions, such as installing non-python dependencies. The audience is systems administrators. ]
This module depends on modules ``base``, ``sale_stock``, ``account_payment_return``, ``partner_firstname``,
and ``account_cancel``. Ensure yourself to have all them in your addons list.

4
hotel/readme/ROADMAP.rst Normal file
View File

@@ -0,0 +1,4 @@
.. [ 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. ]
- [ ]

6
hotel/readme/USAGE.rst Normal file
View File

@@ -0,0 +1,6 @@
.. [ 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, please, read the complete user guide at https://roomdoo.com.