info/DesignPatternsPHP
1
0
Fork 0
mirror of https://github.com/DesignPatternsPHP/DesignPatternsPHP.git synced 2025-08-02 13:07:27 +02:00
Code Issues Projects Releases Wiki Activity

Restructured README.md

Browse Source
This commit is contained in:
Dominik Liebler
2018-07-08 17:33:49 +02:00
parent f0f5ee9bef
commit 5c926aee1b
1 changed files with 16 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files

33
README.md
View File

@@ -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. 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: 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 ```bash
$ composer install $ 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). 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: To run the tests use `phpunit`:
```bash
docker-compose run composer install
```
### Running test suite
```bash ```bash
$ ./vendor/bin/phpunit $ ./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 ## 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. 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.