summaryrefslogtreecommitdiff
path: root/README.md
blob: efa199bef8b6ab61bd2c1a2e3e0eefc3e73f4f18 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
# Installation #
Run `composer install` from the root of dipper to install the required dependencies
See `composer.json` for the required packages and version constraints
See `composer.lock` for the current list of packages to be installed

# Configure #
Look at `config/dipper.php.example` to see an example config
Create a `dipper.php` in the root of dipper or in the `confing/` directory
The config file must have a `SITES_ROOT` and a `CONFIG_ROOT` defined

# Run #
run `php scripts/run.php` to execute dipper
run `php scripts/run.php --help` to see application help messages

# Contact #
Email `phil@pgburton.com` with any queries or questions