From f37acfb0461ec4692833a133a34cf255731aa3e7 Mon Sep 17 00:00:00 2001 From: Ryan Barrett Date: Fri, 29 Jan 2016 09:56:08 -0800 Subject: [PATCH] add developing instructions section to readme ...probably more to come :P --- README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/README.md b/README.md index f044804..1fc93b7 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,22 @@ Telegraph is an API for sending [Webmentions](http://webmention.net). See https://telegraph.p3k.io/api +## Developing + +* Fork and clone this repo. +* Install MySQL if it's not already installed. +* Copy `config.template.php` to `config.test.php` and fill in the appropriate + values for your local environment. +* Install the dependences, create a local database, and run the tests: + + ```sh + $ composer install + $ mysql [ARGS] -e 'CREATE DATABASE telegraph;' + $ mysql [ARGS] < schema.sql + $ phpunit + # Hack hack hack! + ``` + ## Credits Telegraph photo: https://www.flickr.com/photos/nostri-imago/3407786186