Skip to content

Commit 52781fd

Browse files
Revise README for improved structure and content
Updated README to enhance clarity and add new sections.
1 parent e2a78d4 commit 52781fd

File tree

1 file changed

+39
-26
lines changed

1 file changed

+39
-26
lines changed

β€ŽREADME.mdβ€Ž

Lines changed: 39 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,52 +1,65 @@
11
<div align="center">
2-
<!-- Title: -->
3-
<a href="https://github.com/TheAlgorithms/">
4-
<img src="https://raw.githubusercontent.com/TheAlgorithms/website/1cd824df116b27029f17c2d1b42d81731f28a920/public/logo.svg" height="100">
5-
</a>
6-
<h1><a href="https://github.com/TheAlgorithms/">The Algorithms</a> - Python</h1>
72

8-
<!-- Labels: -->
9-
<!-- First row: -->
3+
<!-- Logo -->
4+
<a href="https://github.com/TheAlgorithms/">
5+
<img src="https://raw.githubusercontent.com/TheAlgorithms/website/1cd824df116b27029f17c2d1b42d81731f28a920/public/logo.svg" height="100" alt="The Algorithms Logo">
6+
</a>
7+
8+
<h1><a href="https://github.com/TheAlgorithms/">The Algorithms</a> – Python 🐍</h1>
9+
10+
<h3>All algorithms implemented in Python – for learning and exploration πŸ“š</h3>
11+
12+
<!-- Shields Row 1 -->
13+
<p>
1014
<a href="https://gitpod.io/#https://github.com/TheAlgorithms/Python">
11-
<img src="https://img.shields.io/badge/Gitpod-Ready--to--Code-blue?logo=gitpod&style=flat-square" height="20" alt="Gitpod Ready-to-Code">
15+
<img src="https://img.shields.io/badge/Gitpod-Ready--to--Code-blue?logo=gitpod&style=flat-square" alt="Gitpod Ready-to-Code">
1216
</a>
1317
<a href="https://github.com/TheAlgorithms/Python/blob/master/CONTRIBUTING.md">
14-
<img src="https://img.shields.io/static/v1.svg?label=Contributions&message=Welcome&color=0059b3&style=flat-square" height="20" alt="Contributions Welcome">
18+
<img src="https://img.shields.io/static/v1.svg?label=Contributions&message=Welcome&color=0059b3&style=flat-square" alt="Contributions Welcome">
1519
</a>
16-
<img src="https://img.shields.io/github/repo-size/TheAlgorithms/Python.svg?label=Repo%20size&style=flat-square" height="20">
20+
<img src="https://img.shields.io/github/repo-size/TheAlgorithms/Python.svg?label=Repo%20size&style=flat-square" alt="Repository Size">
1721
<a href="https://the-algorithms.com/discord">
18-
<img src="https://img.shields.io/discord/808045925556682782.svg?logo=discord&colorB=7289DA&style=flat-square" height="20" alt="Discord chat">
22+
<img src="https://img.shields.io/discord/808045925556682782.svg?logo=discord&colorB=7289DA&style=flat-square" alt="Discord Chat">
1923
</a>
2024
<a href="https://gitter.im/TheAlgorithms/community">
21-
<img src="https://img.shields.io/badge/Chat-Gitter-ff69b4.svg?label=Chat&logo=gitter&style=flat-square" height="20" alt="Gitter chat">
25+
<img src="https://img.shields.io/badge/Chat-Gitter-ff69b4.svg?label=Chat&logo=gitter&style=flat-square" alt="Gitter Chat">
2226
</a>
27+
</p>
2328

24-
<!-- Second row: -->
25-
<br>
29+
<!-- Shields Row 2 -->
30+
<p>
2631
<a href="https://github.com/TheAlgorithms/Python/actions">
27-
<img src="https://img.shields.io/github/actions/workflow/status/TheAlgorithms/Python/build.yml?branch=master&label=CI&logo=github&style=flat-square" height="20" alt="GitHub Workflow Status">
32+
<img src="https://img.shields.io/github/actions/workflow/status/TheAlgorithms/Python/build.yml?branch=master&label=CI&logo=github&style=flat-square" alt="GitHub Workflow Status">
2833
</a>
2934
<a href="https://github.com/pre-commit/pre-commit">
30-
<img src="https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white&style=flat-square" height="20" alt="pre-commit">
35+
<img src="https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white&style=flat-square" alt="pre-commit enabled">
3136
</a>
3237
<a href="https://docs.astral.sh/ruff/formatter/">
33-
<img src="https://img.shields.io/static/v1?label=code%20style&message=ruff&color=black&style=flat-square" height="20" alt="code style: black">
38+
<img src="https://img.shields.io/static/v1?label=code%20style&message=ruff&color=black&style=flat-square" alt="Code style: Ruff">
3439
</a>
40+
</p>
3541

36-
<!-- Short description: -->
37-
<h3>All algorithms implemented in Python - for education πŸ“š</h3>
3842
</div>
3943

40-
Implementations are for learning purposes only. They may be less efficient than the implementations in the Python standard library. Use them at your discretion.
44+
---
4145

42-
## πŸš€ Getting Started
46+
## 🧠 Overview
47+
48+
**The Algorithms – Python** is a collection of Python implementations for popular algorithms and data structures.
49+
These implementations are designed **for educational purposes** – to help you understand how algorithms work under the hood.
4350

44-
πŸ“‹ Read through our [Contribution Guidelines](CONTRIBUTING.md) before you contribute.
51+
> βš™οΈ Note: These implementations may not be as optimized as those in the Python Standard Library. Use them for learning and experimentation.
4552
46-
## 🌐 Community Channels
53+
---
54+
55+
## πŸš€ Getting Started
4756

48-
We are on [Discord](https://the-algorithms.com/discord) and [Gitter](https://gitter.im/TheAlgorithms/community)! Community channels are a great way for you to ask questions and get help. Please join us!
57+
Before contributing or using the code:
4958

50-
## πŸ“œ List of Algorithms
59+
1. πŸ“˜ Read the [Contribution Guidelines](CONTRIBUTING.md)
60+
2. 🧩 Explore the [Directory](DIRECTORY.md) to discover available algorithms
61+
3. πŸ’‘ Use Gitpod for an instant ready-to-code environment
5162

52-
See our [directory](DIRECTORY.md) for easier navigation and a better overview of the project.
63+
```bash
64+
# Launch the project in Gitpod
65+
https://gitpod.io/#https://github.com/TheAlgorithms/Python

0 commit comments

Comments
Β (0)