-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: update README. Add descriptions and demo for games
- Loading branch information
Showing
2 changed files
with
58 additions
and
8 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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) |