Skip to content

Commit 95afd01

Browse files
[pre-commit.ci] auto fixes from pre-commit.com hooks
for more information, see https://pre-commit.ci
1 parent e1ede13 commit 95afd01

1 file changed

Lines changed: 9 additions & 0 deletions

File tree

README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,7 @@ This repository includes implementations of algorithms across multiple categorie
7070
- **And many more!**
7171

7272
All implementations include:
73+
7374
- Clear documentation and explanations
7475
- Type hints for better code readability
7576
- Doctests for validation
@@ -80,12 +81,14 @@ All implementations include:
8081
### Installation
8182

8283
1. **Clone the repository**
84+
8385
```bash
8486
git clone https://github.com/TheAlgorithms/Python.git
8587
cd Python
8688
```
8789

8890
2. **Set up a virtual environment (recommended)**
91+
8992
```bash
9093
python -m venv venv
9194

@@ -97,6 +100,7 @@ All implementations include:
97100
```
98101

99102
3. **Install dependencies**
103+
100104
```bash
101105
pip install -r requirements.txt
102106
```
@@ -106,11 +110,13 @@ All implementations include:
106110
Each algorithm is self-contained in its own file. You can run any algorithm directly or import it into your own projects.
107111

108112
**Example 1: Running an algorithm directly**
113+
109114
```bash
110115
python sorts/quick_sort.py
111116
```
112117

113118
**Example 2: Importing and using an algorithm**
119+
114120
```python
115121
from sorts.quick_sort import quick_sort
116122

@@ -121,6 +127,7 @@ print(sorted_numbers) # Output: [11, 12, 22, 25, 34, 64, 90]
121127
```
122128

123129
**Example 3: Running doctests**
130+
124131
```bash
125132
python -m doctest -v sorts/bubble_sort.py
126133
```
@@ -144,6 +151,7 @@ We welcome contributions from the community! Before contributing:
144151
5. 🎯 Make sure all tests pass before submitting
145152

146153
**Quick Start for Contributors:**
154+
147155
```bash
148156
# Install pre-commit hooks
149157
pip install pre-commit
@@ -158,6 +166,7 @@ ruff check
158166
```
159167

160168
Contributions that are most welcome:
169+
161170
- New algorithm implementations
162171
- Improvements to existing algorithms
163172
- Better documentation and explanations

0 commit comments

Comments
 (0)