Preparing README.txt for 1.1
[project/rooms.git] / README.txt
1 INTRODUCTION
2 ------------
3 Rooms is a family of modules that enable you to manage Booking for hotels,
4 B&Bs and vacation rentals.
5
6 It builds on the Drupal CMS (drupal.org) and its modules.
7
8
9 INSTALLATION
10 ------------
11 Follow the steps below to install Rooms.
12
13 1. Download the FullCalendar library from [1] and unpack in `sites/all/libraries`
14 so that you end up with
15 `sites/all/libraries/rooms_fullcalendar/fullcalendar/fullcalendar.js`.
16
17 Rooms uses FullCalendar to display room availability and prices by date in an
18 easily comprehensible manner.
19
20 Please do not use the download from the FullCalendar website, as Rooms
21 requires a custom fork of actual FullCalendar library which provides a extra
22 view and some simple enhancements that make sense for this application.
23
24 *It is not necessary to install a Drupal module called fullcalendar.*
25
26 2. Activate all the Rooms modules and their dependencies. Dependencies will
27 be automatically downloaded if using [drush][2] to enable the Rooms modules.
28 Alternatively please make sure you download all dependencies (which can be
29 seen in the modules page).
30
31 At this point the module is installed and you should proceed with configuration.
32
33
34 CONFIGURATION
35 -------------
36
37 1. Visit `admin/rooms/units/unit-types` and create a unit type (e.g. standard
38 double room).
39
40 2. Visit `admin/rooms/units` and create a couple of bookable units.
41
42 3. Set availability and pricing - clicking on events or date ranges in the
43 calendars will bring up a pop-up dialog and allow you to interact with them.
44
45 4. To manually create a Booking go to `admin/rooms/bookings/add`. This will also
46  create a Commerce order and line item for that booking.
47
48 5. Potential guests can go to `/booking` to do an availability search.
49
50 6. If you wish to display availability information on an embedded calendar
51 in a node (as vacation rentals properties often do) activate the Rooms
52 Availability Reference Module.
53
54 6a. This will give you a new field type called "Availability Reference".
55
56 6b. Add the field to any entity and you may reference specific Booking Units
57 to have the availability information rendered on the node display (or any
58 other entity).
59
60 The results of the availability search are the rooms available over the
61 period - adding one to a cart will create a Room Booking Unit commerce
62 product for it and place it in the cart. Once checkout is completed the calendar
63 is updated to reflect the change.
64
65 Please join us in the [Rooms issue queue][3] and collaborate with us to create a
66 great booking solution for Drupal!
67
68
69 PHP REQUIREMENTS & DATE REQUIREMENTS
70 --------------------------------------
71 The use of the DateInterval class means that we require PHP version 5.3
72 or greater.
73
74 In general, this module makes use of latest Date functionality in PHP, so
75 ensure that it is enabled in your PHP setup. We may scale back on this
76 to make things more usable for a wider range of configurations.
77
78
79 UPGRADING FROM PREVIOUS VERSIONS
80 -------------------------------------
81 Please make sure you test extensively on a test site before upgrading!
82
83 UNINSTALLATION
84 -------------------------------------
85 If you wish to uninstall Rooms, you must disable and uninstall the modules
86 it provides in reverse order of dependencies. After disabling each module
87 that is available to be disabled, visit the 'uninstall' tab and uninstall it.
88
89    [1]: http://www.drupalrooms.com/sites/default/files/fullcalendar-1.5.4.zip "Rooms Fullcalendar fork"
90    [2]: http://drupal.org/project/drush "Drush, the Drupal shell"
91    [3]: http://drupal.org/project/issues/rooms "Rooms issue queue on Drupal.org"