diff --git a/.gitignore b/.gitignore index 5703522..7ae4f63 100644 --- a/.gitignore +++ b/.gitignore @@ -7,3 +7,7 @@ composer.lock /res/protected/ /.idea doc/api/* + +libpairtwo-distro\.zip + +distro/ diff --git a/.libpairtwo-distro b/.libpairtwo-distro new file mode 100644 index 0000000..e69de29 diff --git a/CHANGELOG.md b/CHANGELOG.md index 1c66e60..af60c28 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -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 diff --git a/Makefile b/Makefile index 7269f15..fe0f3eb 100644 --- a/Makefile +++ b/Makefile @@ -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 diff --git a/res/boilerplate.php b/res/boilerplate.php new file mode 100644 index 0000000..66d06f9 --- /dev/null +++ b/res/boilerplate.php @@ -0,0 +1,12 @@ +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 diff --git a/res/composer-dist-installed.json b/res/composer-dist-installed.json new file mode 100644 index 0000000..beccd86 --- /dev/null +++ b/res/composer-dist-installed.json @@ -0,0 +1,5 @@ +{ + "require": { + "jeroened/libpairtwo": "^1.0" + } +} \ No newline at end of file diff --git a/res/composer-dist.json b/res/composer-dist.json new file mode 100644 index 0000000..7aece67 --- /dev/null +++ b/res/composer-dist.json @@ -0,0 +1,12 @@ +{ + "repositories": [ + { + "type": "git", + "url": "../" + } + ], + "require": { + "jeroened/libpairtwo": "*" + }, + "minimum-stability": "dev" +} \ No newline at end of file