Skip to content

Commit 414c184

Browse files
author
vdz
committed
update README
1 parent 3741534 commit 414c184

File tree

1 file changed

+81
-6
lines changed

1 file changed

+81
-6
lines changed

README.md

Lines changed: 81 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,83 @@
11
### Hexlet tests and linter status:
22
[![Actions Status](https://github.com/vdzshnik001/python-project-49/actions/workflows/hexlet-check.yml/badge.svg)](https://github.com/vdzshnik001/python-project-49/actions)
3-
[brain-ever](https://asciinema.org/a/avoNamJdvwgjFOQLcmBiRqJOS)
4-
[brain-calc](https://asciinema.org/a/AYruD6OIG0CBHtTbhYb9OisIf)
5-
[brain-calc2](https://asciinema.org/a/r8Hw8e7CLxCPSKtAwjVHUFBti)
6-
[brain-gcd](https://asciinema.org/a/prwyhhTVmkHHtos6hjeuPoxIT)
7-
[brain-progression](https://asciinema.org/a/p3MHCOqgK9du3SJNuYlEAlUYf)
8-
[brain-prime](https://asciinema.org/a/YY1FQnzzk85OGBPHeFVq2nqRq)
3+
[![Maintainability](https://api.codeclimate.com/v1/badges/84bf161038a06bd52b1f/maintainability)](https://codeclimate.com/github/vdzshnik001/python-project-49/maintainability)
4+
5+
## Demo links
6+
7+
### make lint, make brain-games, make brain-even: https://asciinema.org/a/pwS7904IAkBWJbOyiUSkn3j4U
8+
### make brain-calc: https://asciinema.org/a/r8Hw8e7CLxCPSKtAwjVHUFBti
9+
### make brain-gcd: https://asciinema.org/a/prwyhhTVmkHHtos6hjeuPoxIT
10+
### make brain-progression: https://asciinema.org/a/p3MHCOqgK9du3SJNuYlEAlUYf
11+
### make brain-prime: https://asciinema.org/a/YY1FQnzzk85OGBPHeFVq2nqRq
12+
13+
# Brain Games
14+
15+
Hexlet tests and linter status:
16+
Actions Status Maintainability
17+
18+
## Description
19+
Brain Games is a set of five console games built for educational purposes. Each game poses a challenge that requires basic arithmetic, logic, or number theory skills.
20+
21+
## Minimum Requirements
22+
- Python 3.13+
23+
## Installation
24+
1. Clone the repository:
25+
26+
git clone [email protected]:vdzshnik001/python-project-49.git
27+
28+
3. Navigate to the project directory:
29+
30+
cd brain-games
31+
32+
3. Install the dependencies using Poetry:
33+
34+
make install
35+
36+
## Running the Games
37+
The project includes the following games:
38+
39+
Brain Even
40+
41+
Brain Calc
42+
43+
Brain GCD
44+
45+
Brain Progression
46+
47+
Brain Prime
48+
49+
## Launching a Game
50+
To launch a specific game, use the following commands:
51+
52+
Brain Even:
53+
54+
make brain-even
55+
56+
Brain Calc:
57+
58+
make brain-calc
59+
60+
Brain GCD:
61+
62+
make brain-gcd
63+
64+
Brain Progression:
65+
66+
make brain-progression
67+
68+
Brain Prime:
69+
70+
make brain-prime
71+
72+
## Example Commands
73+
Build the project:
74+
75+
make build
76+
77+
Install the package:
78+
79+
make install
80+
81+
Lint the project:
82+
83+
make lint

0 commit comments

Comments
 (0)