From e237e378a0bfc6e906d7cf682fc7f7fd4af74528 Mon Sep 17 00:00:00 2001 From: Fbenas Date: Fri, 25 Aug 2017 01:54:52 +0100 Subject: Add readme --- README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) create mode 100644 README.md (limited to 'README.md') 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 -- cgit v1.2.3