mirror of
https://github.com/JeroenED/libpairtwo.git
synced 2024-11-21 22:17:41 +01:00
Created 1. Getting Started (markdown)
parent
4e918b3781
commit
345a7d61cf
33
1.-Getting-Started.md
Normal file
33
1.-Getting-Started.md
Normal file
@ -0,0 +1,33 @@
|
||||
# Getting started
|
||||
|
||||
## Installing Libpairtwo
|
||||
You can easily start using libpairtwo by installing it via composer
|
||||
|
||||
```bash
|
||||
$ composer install JeroenED/libpairtwo
|
||||
```
|
||||
|
||||
In you initialization code add the vendor/autoload.php
|
||||
```php
|
||||
require_once("vendor/autoload.php");
|
||||
```
|
||||
|
||||
## Reading out a pairing-file
|
||||
Reading out a pairing-file is very simple. First create a reader. This is simply done by using the IOFactory::createReader() method. Then call the `read` method of the return value of the `IOFactory::createReader()` method.
|
||||
|
||||
```php
|
||||
require_once("vendor/autoload.php");
|
||||
use JeroenED/Libpairtwo/IOFactory;
|
||||
|
||||
$filereader = IOFactory::createReader('Pairtwo-6');
|
||||
$filereader->read('mycompetition.sws');
|
||||
```
|
||||
This will return a usable object for reaching out for results, rankings, etc.
|
||||
|
||||
## Getting methods of the class
|
||||
I didn't want to add the generated phpdoc in this library simply because it is generated.
|
||||
|
||||
The command to generate it yourself is just `$ phpdoc`. This will generate the docs in the doc/api folder.
|
||||
|
||||
## Examples
|
||||
You can find several exampl
|
Loading…
Reference in New Issue
Block a user