Skip to content

Commit 24e077c

Browse files
committed
update readme
1 parent 60674ee commit 24e077c

File tree

1 file changed

+20
-14
lines changed

1 file changed

+20
-14
lines changed

README.md

Lines changed: 20 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -30,19 +30,35 @@ The project requires **Python 3.12 or newer** and the **`uv`** package manager/b
3030
To install the package as a command-line tool, you must complete the full cycle: dependency synchronization, **wheel file creation**, and final installation. These steps are automated by the `make install-games` command:
3131

3232
```bash
33-
# Clone the repository
33+
# 1. Clone the repository
34+
# Choose one method:
35+
# HTTPS (Universal):
3436
git clone [https://github.com/Cheshire-12/python-project-49.git](https://github.com/Cheshire-12/python-project-49.git)
35-
cd python-project-49
3637

38+
# SSH (Requires SSH key setup):
39+
git clone [email protected]:Cheshire-12/python-project-49.git
40+
41+
# 2. Run the automated installation command
3742
# Executes: uv sync, uv build, uv tool install dist/*.whl
3843
make install-games
3944
```
40-
### 2. Running a Game
45+
**Important**: After running this command, all executable scripts (e.g., `brain-even`, `brain-calc`) become available directly in your terminal without needing the `uv run` prefix.
46+
### 2. Running a Game
4147
You can start any game by typing its corresponding command.
4248
```bash
4349
brain-calc
4450
```
4551

52+
### 📊 Project Status
53+
54+
| Tool | Status |
55+
| :--- | :--- |
56+
| **Hexlet Tests** | [![Actions Status](https://github.com/Cheshire-12/python-project-49/actions/workflows/hexlet-check.yml/badge.svg)](https://github.com/Cheshire-12/python-project-49/actions) |
57+
| **SonarCloud Quality Gate** | [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=Cheshire-12_python-project-49&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=Cheshire-12_python-project-49) |
58+
| **Code Smells** | [![Code Smells](https://sonarcloud.io/api/project_badges/measure?project=Cheshire-12_python-project-49&metric=code_smells)](https://sonarcloud.io/summary/new_code?id=Cheshire-12_python-project-49) |
59+
| **Maintainability Rating** | [![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=Cheshire-12_python-project-49&metric=sqale_rating)](https://sonarcloud.io/summary/new_code?id=Cheshire-12_python-project-49) |
60+
| **Vulnerabilities** | [![Vulnerabilities](https://sonarcloud.io/api/project_badges/measure?project=Cheshire-12_python-project-49&metric=vulnerabilities)](https://sonarcloud.io/summary/new_code?id=Cheshire-12_python-project-49) |
61+
4662
### Game: "Parity Check"
4763
[![asciicast](https://asciinema.org/a/IlTxJPW7mvdKo2OIxgMhK3woq.svg)](https://asciinema.org/a/IlTxJPW7mvdKo2OIxgMhK3woq)
4864

@@ -56,14 +72,4 @@ brain-calc
5672
[![asciicast](https://asciinema.org/a/5xNE302Kgqa2D6VYizzAr0asK.svg)](https://asciinema.org/a/5xNE302Kgqa2D6VYizzAr0asK)
5773

5874
### Game: "Is a number prime?"
59-
[![asciicast](https://asciinema.org/a/QT7OfDWcYaG7Htl7gYAS54t8X.svg)](https://asciinema.org/a/QT7OfDWcYaG7Htl7gYAS54t8X)
60-
61-
## 📊 Project Status
62-
63-
| Tool | Status |
64-
| :--- | :--- |
65-
| **Hexlet Tests** | [![Actions Status](https://github.com/Cheshire-12/python-project-49/actions/workflows/hexlet-check.yml/badge.svg)](https://github.com/Cheshire-12/python-project-49/actions) |
66-
| **SonarCloud Quality Gate** | [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=Cheshire-12_python-project-49&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=Cheshire-12_python-project-49) |
67-
| **Code Smells** | [![Code Smells](https://sonarcloud.io/api/project_badges/measure?project=Cheshire-12_python-project-49&metric=code_smells)](https://sonarcloud.io/summary/new_code?id=Cheshire-12_python-project-49) |
68-
| **Maintainability Rating** | [![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=Cheshire-12_python-project-49&metric=sqale_rating)](https://sonarcloud.io/summary/new_code?id=Cheshire-12_python-project-49) |
69-
| **Vulnerabilities** | [![Vulnerabilities](https://sonarcloud.io/api/project_badges/measure?project=Cheshire-12_python-project-49&metric=vulnerabilities)](https://sonarcloud.io/summary/new_code?id=Cheshire-12_python-project-49) |
75+
[![asciicast](https://asciinema.org/a/QT7OfDWcYaG7Htl7gYAS54t8X.svg)](https://asciinema.org/a/QT7OfDWcYaG7Htl7gYAS54t8X)

0 commit comments

Comments
 (0)