| 1 | OpenGuides installation instructions |
|---|
| 2 | ==================================== |
|---|
| 3 | |
|---|
| 4 | OpenGuides installation has two steps - installing the modules, and setting |
|---|
| 5 | up a Guide. Module installation is described in this file, and setting up |
|---|
| 6 | a Guide is described in SETUP. |
|---|
| 7 | |
|---|
| 8 | |
|---|
| 9 | * Basic installation of modules |
|---|
| 10 | |
|---|
| 11 | The OpenGuides distribution _should_ be installable with CPAN.pm or |
|---|
| 12 | CPANPLUS.pm - i.e., the CPAN shell - and this is probably the simplest |
|---|
| 13 | way to do it unless you already know you prefer manual installation. |
|---|
| 14 | |
|---|
| 15 | If you do prefer manual installation, then: |
|---|
| 16 | |
|---|
| 17 | Unpack the distribution (using for example 'tar' or 'WinZip'), and set |
|---|
| 18 | your working directory (using for example 'cd') to be the top level of |
|---|
| 19 | the distribution. |
|---|
| 20 | |
|---|
| 21 | Now execute the following commands: |
|---|
| 22 | |
|---|
| 23 | perl Build.PL |
|---|
| 24 | perl Build |
|---|
| 25 | perl Build test |
|---|
| 26 | |
|---|
| 27 | These will prepare your system for installation of the modules, and run some |
|---|
| 28 | tests to make sure that everything is OK. If everything is not OK, then please |
|---|
| 29 | report a bug. If everything is OK, i.e. all the tests report success, then |
|---|
| 30 | |
|---|
| 31 | perl Build install |
|---|
| 32 | |
|---|
| 33 | should install the modules for you. If you get error messages saying |
|---|
| 34 | you don't have the correct permissions, then you need to do something |
|---|
| 35 | along the lines of 'sudo perl Build install', or install the modules |
|---|
| 36 | in a directory that you do have permission to write to (see below), or |
|---|
| 37 | ask your sysadmin to do the installation for you. |
|---|
| 38 | |
|---|
| 39 | |
|---|
| 40 | * Custom install locations |
|---|
| 41 | |
|---|
| 42 | If you wish to install the OpenGuides modules in a private directory, |
|---|
| 43 | you will need to specify this when you run the Build.PL. |
|---|
| 44 | |
|---|
| 45 | If you are using version 0.20 or newer of Module::Build, do: |
|---|
| 46 | |
|---|
| 47 | perl Build.PL install_path=lib=/path/to/my/modules/ \ |
|---|
| 48 | install_path=script=/path/to/my/bin/ \ |
|---|
| 49 | install_path=arch=/path/to/my/modules/auto/ \ |
|---|
| 50 | install_path=libdoc=/path/to/my/man/ \ |
|---|
| 51 | install_path=bindoc=/path/to/my/man/ |
|---|
| 52 | |
|---|
| 53 | Or for earlier versions of Module::Build, do: |
|---|
| 54 | |
|---|
| 55 | perl Build.PL config='sitelib=/path/to/my/modules/' |
|---|
| 56 | |
|---|
| 57 | If you do choose this option, then when you come to set up a Guide you'll |
|---|
| 58 | need to make sure that the scripts know where to find your modules. See |
|---|
| 59 | the documentation on custom lib paths in SETUP. |
|---|
