diff --git a/README.md b/README.md index cc648966..14d295f0 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,17 @@

NFQ Group

+ # GildedRose Kata - PHP Version ## Installation -The kata uses: +##### The kata uses: - [8.0+](https://www.php.net/downloads.php) - [Composer](https://getcomposer.org) -Recommended: +##### Recommended: - [Git](https://git-scm.com/downloads) @@ -27,17 +28,17 @@ or git clone https://github.com/thang-tran-nfq/GildedRose-Refactoring-Kata.git ``` -Setup docker-compose +##### Setup docker-compose ```shell script docker-compose up -d ``` -Exec the docker container +##### Exec the docker container ```shell script docker exec -it php-cli bash ``` -Install all the dependencies using composer +##### Install all the dependencies using composer ```shell script cd ./GildedRose-Refactoring-Kata @@ -46,7 +47,7 @@ composer install ## Dependencies -The project uses composer to install: +##### The project uses composer to install: - [PHPUnit](https://phpunit.de/) - [ApprovalTests.PHP](https://github.com/approvals/ApprovalTests.php) @@ -77,7 +78,7 @@ The project uses composer to install: ## Fixture -To run the fixture from the php directory: +##### To run the fixture from the php directory: ```shell php .\fixtures\texttest_fixture.php 10 @@ -94,13 +95,6 @@ project run: composer tests ``` -A Windows a batch file has been created, like an alias on Linux/Mac (e.g. `alias pu="composer tests"`), the same -PHPUnit `composer tests` can be run: - -```shell script -pu.bat -``` - ### Tests with Coverage Report To run all test and generate a html coverage report run: @@ -127,13 +121,6 @@ To check code, but not fix errors: composer check-cs ``` -On Windows a batch file has been created, like an alias on Linux/Mac (e.g. `alias cc="composer check-cs"`), the same -PHPUnit `composer check-cs` can be run: - -```shell script -cc.bat -``` - ### Fix Code ECS provides may code fixes, automatically, if advised to run --fix, the following script can be run: @@ -142,13 +129,6 @@ ECS provides may code fixes, automatically, if advised to run --fix, the followi composer fix-cs ``` -On Windows a batch file has been created, like an alias on Linux/Mac (e.g. `alias fc="composer fix-cs"`), the same -PHPUnit `composer fix-cs` can be run: - -```shell script -fc.bat -``` - ## Static Analysis PHPStan is used to run static analysis checks: @@ -157,11 +137,4 @@ PHPStan is used to run static analysis checks: composer phpstan ``` -On Windows a batch file has been created, like an alias on Linux/Mac (e.g. `alias ps="composer phpstan"`), the same -PHPUnit `composer phpstan` can be run: - -```shell script -ps.bat -``` - **Happy coding**! diff --git a/cc.bat b/cc.bat deleted file mode 100644 index fa81b658..00000000 --- a/cc.bat +++ /dev/null @@ -1 +0,0 @@ -composer check-cs diff --git a/fc.bat b/fc.bat deleted file mode 100644 index c571652e..00000000 --- a/fc.bat +++ /dev/null @@ -1 +0,0 @@ -composer fix-cs diff --git a/ps.bat b/ps.bat deleted file mode 100644 index 8bda091e..00000000 --- a/ps.bat +++ /dev/null @@ -1 +0,0 @@ -composer phpstan diff --git a/pu.bat b/pu.bat deleted file mode 100644 index 38a0c5e9..00000000 --- a/pu.bat +++ /dev/null @@ -1 +0,0 @@ -composer tests