From 036e661e8032df6bde85e143f781baa386c81c02 Mon Sep 17 00:00:00 2001 From: Pablo Date: Fri, 27 Sep 2019 08:25:31 +0200 Subject: [PATCH] [ADD] readme files structure for future oca-gen-addon-readme --- hotel/README.rst | 2 +- hotel/readme/CONFIGURE.rst | 6 ++++++ hotel/readme/CONTRIBUTORS.rst | 1 + hotel/readme/CREDITS.rst | 2 ++ hotel/readme/DESCRIPTION.rst | 7 +++++++ hotel/readme/INSTALL.rst | 5 +++++ hotel/readme/ROADMAP.rst | 4 ++++ hotel/readme/USAGE.rst | 6 ++++++ 8 files changed, 32 insertions(+), 1 deletion(-) create mode 100644 hotel/readme/CONFIGURE.rst create mode 100644 hotel/readme/CONTRIBUTORS.rst create mode 100644 hotel/readme/CREDITS.rst create mode 100644 hotel/readme/DESCRIPTION.rst create mode 100644 hotel/readme/INSTALL.rst create mode 100644 hotel/readme/ROADMAP.rst create mode 100644 hotel/readme/USAGE.rst diff --git a/hotel/README.rst b/hotel/README.rst index 02b6b4fd0..b82dd55db 100644 --- a/hotel/README.rst +++ b/hotel/README.rst @@ -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. diff --git a/hotel/readme/CONFIGURE.rst b/hotel/readme/CONFIGURE.rst new file mode 100644 index 000000000..be4b60011 --- /dev/null +++ b/hotel/readme/CONFIGURE.rst @@ -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. \ No newline at end of file diff --git a/hotel/readme/CONTRIBUTORS.rst b/hotel/readme/CONTRIBUTORS.rst new file mode 100644 index 000000000..141a95efb --- /dev/null +++ b/hotel/readme/CONTRIBUTORS.rst @@ -0,0 +1 @@ +.. authors are taken from the __manifest__.py file diff --git a/hotel/readme/CREDITS.rst b/hotel/readme/CREDITS.rst new file mode 100644 index 000000000..61d2f78cc --- /dev/null +++ b/hotel/readme/CREDITS.rst @@ -0,0 +1,2 @@ +.. [ This file is optional and contains additional credits, other than +authors, contributors, and maintainers. ] \ No newline at end of file diff --git a/hotel/readme/DESCRIPTION.rst b/hotel/readme/DESCRIPTION.rst new file mode 100644 index 000000000..2e7db9fc7 --- /dev/null +++ b/hotel/readme/DESCRIPTION.rst @@ -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. \ No newline at end of file diff --git a/hotel/readme/INSTALL.rst b/hotel/readme/INSTALL.rst new file mode 100644 index 000000000..f6504d125 --- /dev/null +++ b/hotel/readme/INSTALL.rst @@ -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. \ No newline at end of file diff --git a/hotel/readme/ROADMAP.rst b/hotel/readme/ROADMAP.rst new file mode 100644 index 000000000..d49912e0a --- /dev/null +++ b/hotel/readme/ROADMAP.rst @@ -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. ] + +- [ ] \ No newline at end of file diff --git a/hotel/readme/USAGE.rst b/hotel/readme/USAGE.rst new file mode 100644 index 000000000..7fac9ecd5 --- /dev/null +++ b/hotel/readme/USAGE.rst @@ -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. \ No newline at end of file