diff --git a/CHANGELOG.md b/CHANGELOG.md index 715479f..9fa69b8 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,6 +1,6 @@ # CHANGELOG -## vx.x.x (Released: xx-xxx-xx) +## v1.1 (Released: 20-jun-2019) * NEW FEATURE: Libpairtwo distribution releases (use these if you don't have knowledge of composer or dependency management) * NEW FEATURE: Soccer Kashdan (aka: kashdan using 3-1-0 scoring) * MAJOR CHANGE: Model Classes has been removed diff --git a/Doxyfile b/Doxyfile index 4141fdf..289846a 100644 --- a/Doxyfile +++ b/Doxyfile @@ -38,7 +38,7 @@ PROJECT_NAME = libpairtwo # could be handy for archiving the generated documentation or if some version # control system is used. -PROJECT_NUMBER = master +PROJECT_NUMBER = v1.1 # Using the PROJECT_BRIEF tag one can provide an optional one line description # for a project that appears at the top of each page and should give viewer a diff --git a/dist/boilerplate.php b/dist/boilerplate.php index ed288ff..521013a 100644 --- a/dist/boilerplate.php +++ b/dist/boilerplate.php @@ -8,13 +8,14 @@ require_once 'vendor/autoload.php'; // EDIT ME! $pairingfile = 'your pairing-file.sws'; +$fileformat = 'Pairtwo-6'; // Possible values: Pairtwo-5, Pairtwo-6 if (!file_exists($pairingfile)) { trigger_error('Your file is not set or doesn\'t exist! Edit the file: ' . __FILE__ . ' and try again', E_USER_ERROR); } -$reader = IOFactory::createReader('Pairtwo-6'); +$reader = IOFactory::createReader($fileformat); $reader->read($pairingfile); // From here on you can start. Please use the examples on https://github.com/jeroened/libpairtwo/wiki diff --git a/dist/readme.md b/dist/readme.md index d677daf..70875ff 100644 --- a/dist/readme.md +++ b/dist/readme.md @@ -4,7 +4,7 @@ This distribution is a good start to use libpairtwo if you don't have knowledge How to use this distribution? ----------------------------- -The file `boilerplate.php` is the one you'll probably want to work with. You'll want to point your browser to file file. It contains some initializations where the most important one is the variable `$pairingfile`. You'll want to set this to existing pairing file. +The file `boilerplate.php` is the one you'll probably want to work with. You'll want to point your browser to this file. It contains some initializations where the most important one is the variable `$pairingfile`. You'll want to set this to existing pairing file. The other variable (`$pairingfileformat`) is a variable that defines the format of the above pairing file. For now only `Pairtwo-6` and `Pairtwo-5` are available. In the future more formats will become available. Below the comments you'll find some example code. This code is only a aggregation of several fields that are read out. If you need any modifications like putting the rankings in a table or you want to just write it to a file, go ahead it's all yours.