Merge branch 'task/make-dist' into develop

This commit is contained in:
Jeroen De Meerleer 2019-06-17 15:30:22 +02:00
commit 179eb9e111
Signed by: JeroenED
GPG Key ID: 28CCCB8F62BFADD6
7 changed files with 57 additions and 0 deletions

4
.gitignore vendored
View File

@ -7,3 +7,7 @@ composer.lock
/res/protected/
/.idea
doc/api/*
libpairtwo-distro\.zip
distro/

0
.libpairtwo-distro Normal file
View File

View File

@ -1,6 +1,7 @@
# CHANGELOG
## vx.x.x (Released: xx-xxx-xx)
* 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)
* CHANGE: Deprecated `sws::class` was removed
* CHANGE: Added a logo to the project

View File

@ -13,6 +13,29 @@ coverage: ## Executes the test suite and creates code coverage reports
view-coverage: ## Shows the code coverage report
open build/coverage/index.html
api: ## Generates api-docs
wget -O vendor/bin/phpdoc http://www.phpdoc.org/phpDocumentor.phar
chmod +x vendor/bin/phpdoc
vendor/bin/phpdoc
distro: ## Generates distribution
mkdir distro
touch .libpairtwo-distro
git add -A
git commit -m "Commit before release"
cp res/composer-dist.json distro/composer.json
cd distro && composer install
rm distro/composer.json
cp res/composer-dist-installed.json distro/composer.json
git reset --soft HEAD^
wget -O vendor/bin/phpdoc http://www.phpdoc.org/phpDocumentor.phar
chmod +x vendor/bin/phpdoc
vendor/bin/phpdoc
mkdir -p distro/doc
cp -r doc/api distro/doc
cp -r res/boilerplate.php distro/libpairtwo.php
cd distro && zip -r ../libpairtwo-distro *
cs: ## Fixes coding standard problems
vendor/bin/php-cs-fixer fix || true

12
res/boilerplate.php Normal file
View File

@ -0,0 +1,12 @@
<?php
use JeroenED\Libpairtwo\IOFactory;
require_once 'vendor/autoload.php';
$reader = IOFactory::createReader('Pairtwo-6');
$reader->read('your pairing-file.sws');
// From here on you can start. Please use the examples on https://github.com/jeroened/libpairtwo/wiki
// You can also use the doc/api folder to get all possible methods and fields

View File

@ -0,0 +1,5 @@
{
"require": {
"jeroened/libpairtwo": "^1.0"
}
}

12
res/composer-dist.json Normal file
View File

@ -0,0 +1,12 @@
{
"repositories": [
{
"type": "git",
"url": "../"
}
],
"require": {
"jeroened/libpairtwo": "*"
},
"minimum-stability": "dev"
}