diff options
| author | Fbenas <philbeansburton@gmail.com> | 2017-08-25 01:54:52 +0100 |
|---|---|---|
| committer | Fbenas <philbeansburton@gmail.com> | 2017-08-25 01:54:52 +0100 |
| commit | e237e378a0bfc6e906d7cf682fc7f7fd4af74528 (patch) | |
| tree | d2c6256e8bee9e4650ef7933ad832f75bbf3bf09 | |
| parent | 903b671e7d6cc1c289be5dc7f356a9e5fb98dbf7 (diff) | |
Add readme
| -rw-r--r-- | README.md | 16 |
1 files changed, 16 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..efa199b --- /dev/null +++ b/README.md @@ -0,0 +1,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 |