mirror of
https://github.com/DesignPatternsPHP/DesignPatternsPHP.git
synced 2025-07-30 11:40:13 +02:00
Restructured README.md
This commit is contained in:
33
README.md
33
README.md
@@ -15,34 +15,33 @@ I think the problem with patterns is that often people do know them but don't kn
|
||||
You should look at and run the tests to see what happens in the example.
|
||||
To do this, you should install dependencies with `Composer` first:
|
||||
|
||||
### [optional] Using Docker
|
||||
|
||||
You can optionally run tests using [Docker for Mac](https://www.docker.com/docker-mac) or [Windows](https://www.docker.com/docker-windows) or native one for [Linux](https://www.docker.com/docker-debian).
|
||||
Just run:
|
||||
```
|
||||
docker-compose up
|
||||
```
|
||||
|
||||
### Install dependencies
|
||||
|
||||
```bash
|
||||
$ composer install
|
||||
```
|
||||
|
||||
Read more about how to install and use `Composer` on your local machine [here](https://getcomposer.org/doc/00-intro.md#installation-linux-unix-osx).
|
||||
|
||||
If you are using Docker, you just have to run:
|
||||
|
||||
```bash
|
||||
docker-compose run composer install
|
||||
```
|
||||
|
||||
### Running test suite
|
||||
To run the tests use `phpunit`:
|
||||
|
||||
```bash
|
||||
$ ./vendor/bin/phpunit
|
||||
```
|
||||
|
||||
## using Docker (optional)
|
||||
|
||||
You can optionally run tests using [Docker for Mac](https://www.docker.com/docker-mac) or [Windows](https://www.docker.com/docker-windows) or native one for [Linux](https://www.docker.com/docker-debian).
|
||||
Just run:
|
||||
|
||||
```
|
||||
docker-compose up
|
||||
```
|
||||
|
||||
To install the dependencies, use `docker-compose` like this:
|
||||
|
||||
```bash
|
||||
docker-compose run composer install
|
||||
```
|
||||
|
||||
## Patterns
|
||||
|
||||
The patterns can be structured in roughly three different categories. Please click on the [:notebook:](http://en.wikipedia.org/wiki/Software_design_pattern) for a full explanation of the pattern on Wikipedia.
|
||||
|
Reference in New Issue
Block a user