Skip to content

Commit

Permalink
Documented benchmarks
Browse files Browse the repository at this point in the history
  • Loading branch information
Rayne committed Aug 24, 2019
1 parent c0ce832 commit 3a7fd91
Showing 1 changed file with 13 additions and 2 deletions.
15 changes: 13 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ from flat file structures with implicit hierarchy.
- [Development](#development)
- [Licence](#licence)
- [Setup](#setup)
- [Benchmarks](#benchmarks)
- [Tests](#tests)
- [Usage](#usage)
- [Search WzItem by ID](#search-wzitem-by-id)
Expand Down Expand Up @@ -90,6 +91,16 @@ composer require rayne/wz2008-graph
* Clone the repository (see the [Tests](#tests) chapter)
* Download a [zipped release](https://github.com/Rayne/wz2008-graph/releases)

## Benchmarks

It is recommended to call the `phpbench` program directly
instead of using the provided `composer bench` script.
The latter will kill the benchmark after five minutes.

```bash
./vendor/bin/phpbench run
```

## Tests

1. Clone the repository
Expand All @@ -101,13 +112,13 @@ composer require rayne/wz2008-graph
2. Install the development dependencies

```bash
composer install --dev
composer install --dev --prefer-dist
```

3. Run the tests

```bash
./vendor/bin/phpunit
composer test
```

## Usage
Expand Down

0 comments on commit 3a7fd91

Please sign in to comment.