Skip to content

Commit f135042

Browse files
committed
Update Readme.md with instructions as a composer project
1 parent c0c312e commit f135042

1 file changed

Lines changed: 7 additions & 5 deletions

File tree

README.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,11 +15,13 @@ It could be useful if you want to start from scratch a kata or a little exercise
1515

1616
## How To Start
1717

18-
1. Clone this repository `git clone https://github.com/CodelyTV/php-bootstrap`.
19-
2. Install all the [Composer](https://getcomposer.org/) dependencies with `composer install`.
20-
3. Run the [PHP Paralel Lint](https://github.com/JakubOnderka/PHP-Parallel-Lint) with `composer lint`.
21-
4. Run the [PHP Unit](https://phpunit.de/) test with `composer phpunit` (you can also run both checks with the `composer test` command).
22-
5. Start your project!
18+
0. If you don't have it already, [install Composer](https://getcomposer.org/download/).
19+
1. Create your project based on this bootstrap repo: `composer create-project codelytv/php-bootstrap your-kata-name`.
20+
2. Run all the checks: `composer test`. This will do some checks that you can perform with isolated commands:
21+
1. [PHP Parallel Lint](https://github.com/JakubOnderka/PHP-Parallel-Lint): `composer lint`.
22+
2. [PHP Style Check](https://github.com/squizlabs/PHP_CodeSniffer): `composer style`. If you want to fix style issues automatically: `composer fix-style`.
23+
3. [PHP Unit](https://phpunit.de/): `composer phpunit`.
24+
3. Start coding!
2325

2426
## Helpful resources
2527

0 commit comments

Comments
 (0)