Skip to content

Commit f4430c9

Browse files
update README.md and pyproject.toml
1 parent 1e3b83f commit f4430c9

File tree

2 files changed

+80
-5
lines changed

2 files changed

+80
-5
lines changed

README.md

Lines changed: 76 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,94 @@
1+
# Brain Games
2+
Python-based games that challenge your mind and develop arithmetic and logic skills.
13
### Hexlet tests and linter status:
24
[![Actions Status](https://github.com/georgebespam/python-project-49/actions/workflows/hexlet-check.yml/badge.svg)](https://github.com/georgebespam/python-project-49/actions)
35

46
### SonarQube badges
5-
67
[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=georgebespam_python-project-49&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=georgebespam_python-project-49)
8+
79
[![Bugs](https://sonarcloud.io/api/project_badges/measure?project=georgebespam_python-project-49&metric=bugs)](https://sonarcloud.io/summary/new_code?id=georgebespam_python-project-49)
8-
[![Code Smells](https://sonarcloud.io/api/project_badges/measure?project=georgebespam_python-project-49&metric=code_smells)](https://sonarcloud.io/summary/new_code?id=georgebespam_python-project-49)
9-
[![Duplicated Lines (%)](https://sonarcloud.io/api/project_badges/measure?project=georgebespam_python-project-49&metric=duplicated_lines_density)](https://sonarcloud.io/summary/new_code?id=georgebespam_python-project-49)
1010
[![Lines of Code](https://sonarcloud.io/api/project_badges/measure?project=georgebespam_python-project-49&metric=ncloc)](https://sonarcloud.io/summary/new_code?id=georgebespam_python-project-49)
11+
1112
[![Reliability Rating](https://sonarcloud.io/api/project_badges/measure?project=georgebespam_python-project-49&metric=reliability_rating)](https://sonarcloud.io/summary/new_code?id=georgebespam_python-project-49)
13+
1214
[![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=georgebespam_python-project-49&metric=security_rating)](https://sonarcloud.io/summary/new_code?id=georgebespam_python-project-49)
13-
[![Technical Debt](https://sonarcloud.io/api/project_badges/measure?project=georgebespam_python-project-49&metric=sqale_index)](https://sonarcloud.io/summary/new_code?id=georgebespam_python-project-49)
15+
1416
[![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=georgebespam_python-project-49&metric=sqale_rating)](https://sonarcloud.io/summary/new_code?id=georgebespam_python-project-49)
17+
1518
[![Vulnerabilities](https://sonarcloud.io/api/project_badges/measure?project=georgebespam_python-project-49&metric=vulnerabilities)](https://sonarcloud.io/summary/new_code?id=georgebespam_python-project-49)
1619

20+
## Requirements
21+
- Python >= 3.12
22+
- `uv` tool
23+
24+
## Setup
25+
```bash
26+
make install
27+
```
28+
```bash
29+
make build
30+
```
31+
```bash
32+
make package-install
33+
```
34+
<details>
35+
<summary>Installation demo</summary>
36+
1737
[![asciicast](https://asciinema.org/a/x5KVoIx59V4polw1d9PxlUT3o.svg)](https://asciinema.org/a/x5KVoIx59V4polw1d9PxlUT3o)
38+
</details>
39+
40+
## Games
41+
### Even Numbers
42+
Run Command:
43+
```bash
44+
brain-even
45+
```
46+
<details>
47+
<summary>brain-even demo</summary>
48+
1849
[![asciicast](https://asciinema.org/a/GgUENSCXAct7tcHUOLNYkEnal.svg)](https://asciinema.org/a/GgUENSCXAct7tcHUOLNYkEnal)
50+
</details>
51+
52+
### Calculator Game
53+
Run Command:
54+
```bash
55+
brain-calc
56+
```
57+
<details>
58+
<summary>brain-calc demo</summary>
59+
1960
[![asciicast](https://asciinema.org/a/GJUylBJQn6ZD7C0y3D2nmgvZJ.svg)](https://asciinema.org/a/GJUylBJQn6ZD7C0y3D2nmgvZJ)
61+
</details>
62+
63+
### GCD Challenge
64+
Run Command:
65+
```bash
66+
brain-gcd
67+
```
68+
<details>
69+
<summary>brain-gcd demo</summary>
70+
2071
[![asciicast](https://asciinema.org/a/0uoegM4B0XdEXatmhZkxpx4aZ.svg)](https://asciinema.org/a/0uoegM4B0XdEXatmhZkxpx4aZ)
72+
</details>
73+
74+
### Progression Game
75+
Run Command:
76+
```bash
77+
brain-progression
78+
```
79+
<details>
80+
<summary>brain-progression demo</summary>
81+
2182
[![asciicast](https://asciinema.org/a/B80iGDNU3R2enqvH2GzbcoyQR.svg)](https://asciinema.org/a/B80iGDNU3R2enqvH2GzbcoyQR)
83+
</details>
84+
85+
### Prime Numbers
86+
Run Command:
87+
```bash
88+
brain-prime
89+
```
90+
<details>
91+
<summary>brain-prime demo</summary>
92+
2293
[![asciicast](https://asciinema.org/a/PDg2fhTK0rsyxoUNB6Frrz3n4.svg)](https://asciinema.org/a/PDg2fhTK0rsyxoUNB6Frrz3n4)
94+
</details>

pyproject.toml

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,10 @@
11
[project]
2+
authors = [
3+
{ name = "Georgy Bespamiatnykh" },
4+
]
25
name = "hexlet-code"
36
version = "0.1.0"
4-
description = "Add your description here"
7+
description = "Python-based games that challenge your mind and develop arithmetic and logic skills."
58
readme = "README.md"
69
requires-python = ">=3.12"
710
dependencies = [

0 commit comments

Comments
 (0)