Skip to content

Commit

Permalink
docs: update README. Add descriptions and demo for games
Browse files Browse the repository at this point in the history
  • Loading branch information
kolotov committed Sep 6, 2023
1 parent ad996ed commit 5d0d383
Show file tree
Hide file tree
Showing 2 changed files with 58 additions and 8 deletions.
9 changes: 5 additions & 4 deletions Makefile
Original file line number Diff line number Diff line change
@@ -1,17 +1,18 @@
init:
docker-compose up -d --build --remove-orphans
make install

install:
composer install
docker-compose run --rm composer install

validate:
composer validate
docker-compose run --rm composer validate

refresh:
composer dump-autoload
docker-compose run --rm composer dump-autoload

lint:
composer exec --verbose phpcs -- --standard=PSR12 src bin
docker-compose run --rm composer exec --verbose phpcs -- --standard=PSR12 src bin

brain-games:
./bin/brain-games
Expand Down
57 changes: 53 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,57 @@
### Demo
[![Actions Status](https://github.com/kolotov/php-project-lvl1/workflows/hexlet-check/badge.svg)](https://github.com/kolotov/php-project-lvl1/actions)
[![Maintainability](https://api.codeclimate.com/v1/badges/8b5405069316f7d36331/maintainability)](https://codeclimate.com/github/kolotov/php-project-lvl1/maintainability)

## Brain Games

This game is a study project from the [Hexlet](https://ru.hexlet.io/programs/php/projects/45?ref=122573
) education platform.\

### Requirements

* PHP >= 8.1
* Docker

### How installing

Run this commands in console

```bash
git clone [email protected]:kolotov/php-project-lvl1.git
cd php-project-lvl1
make init
```

### Even Game

You have to guess if the number is even or not.\
For run game `make brain-even` or `./bin/brain-even`

[![asciicast](https://asciinema.org/a/604956.svg)](https://asciinema.org/a/604956)

### Hexlet tests and linter status:
### Calc Game

[![Actions Status](https://github.com/kolotov/php-project-lvl1/workflows/hexlet-check/badge.svg)](https://github.com/kolotov/php-project-lvl1/actions)
[![Maintainability](https://api.codeclimate.com/v1/badges/8b5405069316f7d36331/maintainability)](https://codeclimate.com/github/kolotov/php-project-lvl1/maintainability)
You have to calculate two numbers.\
For run game `make brain-calc` or `./bin/brain-calc`

[![asciicast](https://asciinema.org/a/HGR23fT5uvqC6GQlNG5vBVCh4.svg)](https://asciinema.org/a/HGR23fT5uvqC6GQlNG5vBVCh4)

### GCD Game

You have to guess the greatest common divisor (GCD) of two numbers.\
For run game `make brain-gcd` or `./bin/brain-gcd`

[![asciicast](https://asciinema.org/a/lPWPrZpgcC9B39zBJFreTeaOf.svg)](https://asciinema.org/a/lPWPrZpgcC9B39zBJFreTeaOf)

### Progression Game

You have to guess the missed number in progression.\
For run game `make progression` or `./bin/progression`

[![asciicast](https://asciinema.org/a/ebQwyw4astJClEPkjhB9QMtsl.svg)](https://asciinema.org/a/ebQwyw4astJClEPkjhB9QMtsl)

### Prime Game

You have to guess if the number is prime or not.\
For run game `make brain-prime` or `./bin/brain-prime`

[![asciicast](https://asciinema.org/a/4BFYeIbNiF6W7K1lwuf41YyM1.svg)](https://asciinema.org/a/4BFYeIbNiF6W7K1lwuf41YyM1)

0 comments on commit 5d0d383

Please sign in to comment.