README.txt

   1 INTRODUCTION
   2 ------------
   3 Rooms is a family of modules that enable you to manage Booking for hotels, B&Bs
   4 and vacation rentals.
   5
   6 It builds on the Drupal CMS (drupal.org) and its modules.
   7
   8 INSTALLATION
   9 ------------
  10 Follow the steps below to install Rooms.
  11
  12 1.  Download the FullCalendar library from http://www.drupalrooms.com/sites/default/files/fullcalendar-1.5.4.zip
  13 and unpack in sites/all/libraries so that you end up with sites/all/libraries/fullcalendar/fullcalendar
  14
  15 We use FullCalendar to display room availability and prices by date in an easily comprehensible manner.
  16
  17 Please do not use the download from the FullCalendar website, as we had to fork the actual FullCalendar library
  18 to add an extra view and provide some simple enhancements that made sense for this application.
  19
  20 *It is not necessary to install a Drupal module called fullcalendar.*
  21
  22 2. Activate all the Rooms modules and their dependencies. Dependencies will be automatically downloaded if
  23 using drush to enable the Rooms modules. Alternatively please make sure you download all dependencies (which can be seen
  24 in the modules page).
  25
  26 At this point the module is installed and what is required is configuration.
  27
  28 CONFIGURATION
  29 -------------
  30
  31 1. Visit admin/rooms/units/unit-types and create a unit type (e.g. standard double room).
  32
  33 2. Visit admin/rooms/units and create a couple of bookable units.
  34
  35 3. Set availability and pricing - clicking on events will bring up a colorbox and allow you to interact with them.
  36
  37 4. Visit admin/commerce/customer-profiles and create a Customer Profile in Drupal Commerce.
  38
  39 5. Create a Booking at admin/rooms/bookings/add
  40
  41 6. Go to /booking and do an availability search.
  42
  43 7. If you wish to display availability information on an embedded calendar in a node (as vacation rentals properties often do) activate the Rooms Availability Reference Module.
  44 7a. This will give you a new field type called "Availability Reference".
  45 7b. Add the field to any entity and you may reference specific Booking Units to have the availability information rendered on the node display (or any other entity).
  46
  47
  48 The results of the availability search are the rooms available over the period - adding one to a cart
  49 will create a Room Booking Unit commerce product for it and place it in the cart. Once checkout is completed
  50 the calendar is updated to reflect the change.
  51
  52 Please join us in the Rooms issue queue and collaborate with us to create a great booking solution for Drupal!
  53
  54 PHP REQUIREMENTS & DATE REQUIREMENTS
  55 --------------------------------------
  56 The use of the DateInterval class means that we require PHP version 5.3 or greater.
  57
  58 In general, this module makes use of latest Date functionality in PHP, so
  59 ensure that it is enabled in your PHP setup. We may scale back on this
  60 to make things more usable for a wider range of configurations.
  61
  62 UPGRADING FROM PREVIOUS BETA VERSIONS
  63 -------------------------------------
  64 If you are upgrading from Beta 4 make sure that your Rooms Product in Commerce has a price set, the price is not
  65 actually used to calculate the cost of the room but we need a price in order for Commerce to properly add the product
  66 to the cart and do tax calculations.
  67
  68 UNINSTALLATION
  69 -------------------------------------
  70 If you wish to uninstall Rooms, you must disable and uninstall the modules it provides in reverse order of dependencies. After disabling each module that is available to be disabled, visit the 'uninstall' tab and uninstall it.