Skip to content

Commit 982c861

Browse files
authored
Refactor README.md for better readability
Updated README.md to improve formatting and clarity.
1 parent e2a78d4 commit 982c861

File tree

1 file changed

+39
-41
lines changed

1 file changed

+39
-41
lines changed

README.md

Lines changed: 39 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -1,52 +1,50 @@
1-
<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>
7-
8-
<!-- Labels: -->
9-
<!-- First row: -->
10-
<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">
12-
</a>
13-
<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">
15-
</a>
16-
<img src="https://img.shields.io/github/repo-size/TheAlgorithms/Python.svg?label=Repo%20size&style=flat-square" height="20">
17-
<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">
19-
</a>
20-
<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">
22-
</a>
23-
24-
<!-- Second row: -->
25-
<br>
26-
<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">
28-
</a>
29-
<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">
31-
</a>
32-
<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">
34-
</a>
35-
36-
<!-- Short description: -->
37-
<h3>All algorithms implemented in Python - for education 📚</h3>
38-
</div>
1+
# The Algorithms - Python
2+
3+
**All Algorithms implemented in Python - for education 📚**
4+
5+
![Gitpod Ready-to-Code](https://img.shields.io/badge/Gitpod-Ready--to--Code-blue?logo=gitpod)
6+
![Contributions Welcome](https://img.shields.io/badge/Contributions-Welcome-brightgreen)
7+
[![Discord chat](https://img.shields.io/badge/Discord-Join%20us%20on%20Discord-7289DA?logo=discord)](https://discord.gg/c7gVnC6)
8+
[![Gitter chat](https://img.shields.io/badge/Gitter-Join%20the%20chat-ED1965?logo=gitter)](https://gitter.im/TheAlgorithms)
399

4010
Implementations are for learning purposes only. They may be less efficient than the implementations in the Python standard library. Use them at your discretion.
4111

12+
***
13+
4214
## 🚀 Getting Started
4315

44-
📋 Read through our [Contribution Guidelines](CONTRIBUTING.md) before you contribute.
16+
📋 Read through our **[Contribution Guidelines](CONTRIBUTING.md)** before you contribute.
17+
18+
**This is the single most important document you must read before submitting a Pull Request (PR).**
19+
20+
***
4521

4622
## 🌐 Community Channels
4723

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!
24+
We are on **Discord** and **Gitter**! Community channels are a great way for you to ask questions and get help. Please join us!
25+
26+
***
4927

5028
## 📜 List of Algorithms
5129

52-
See our [directory](DIRECTORY.md) for easier navigation and a better overview of the project.
30+
See our **[directory (DIRECTORY.md)](DIRECTORY.md)** for easier navigation and a better overview of the project structure and all available algorithms.
31+
32+
***
33+
34+
## About
35+
36+
* **Website:** [thealgorithms.github.io/Python/](https://thealgorithms.github.io/Python/)
37+
* **Topics:** `python` `education` `algorithm` `practice` `interview` `sorting-algorithms` `learn` `algos` `algorithm-competitions` `sorts` `hacktoberfest` `algorithms-implemented` `community-driven` `searches`
38+
* **License:** [MIT License](LICENSE.md)
39+
* **Code of Conduct:** [Code of conduct](CODE_OF_CONDUCT.md)
40+
* **Contributors:** 1,258+
41+
42+
***
43+
44+
## 💡 How to Contribute (Hacktoberfest Focus)
45+
46+
This project is massive, so your best way to contribute for Hacktoberfest is to find a small, defined task:
47+
48+
1. **Look for Open Issues:** Check the repository's **Issues** page and filter by the labels **`good first issue`** or **`help wanted`**.
49+
2. **Add a New Algorithm:** If you know a popular algorithm not yet implemented, you can write the Python code for it, ensuring it follows the style and includes tests as required in the **`CONTRIBUTING.md`**.
50+
3. **Improve Documentation/Tests:** Add **doctests** or comprehensive unit tests for an existing algorithm file

0 commit comments

Comments
 (0)