Browse Source

Merge pull request #3 from snarfed/developing

add developing instructions section to readme
pull/4/head
Aaron Parecki 8 years ago
parent
commit
531fcdcaec
1 changed files with 16 additions and 0 deletions
  1. +16
    -0
      README.md

+ 16
- 0
README.md View File

@ -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

Loading…
Cancel
Save