|
1 | 1 | <div align="center"> |
2 | | -<!-- Title: --> |
3 | 2 | <a href="https://github.com/TheAlgorithms/"> |
4 | 3 | <img src="https://raw.githubusercontent.com/TheAlgorithms/website/1cd824df116b27029f17c2d1b42d81731f28a920/public/logo.svg" height="100"> |
5 | 4 | </a> |
6 | 5 | <h1><a href="https://github.com/TheAlgorithms/">The Algorithms</a> - Python</h1> |
7 | 6 |
|
8 | | -<!-- Labels: --> |
9 | | - <!-- First row: --> |
10 | 7 | <a href="https://gitpod.io/#https://github.com/TheAlgorithms/Python"> |
11 | 8 | <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 | 9 | </a> |
|
20 | 17 | <a href="https://gitter.im/TheAlgorithms/community"> |
21 | 18 | <img src="https://img.shields.io/badge/Chat-Gitter-ff69b4.svg?label=Chat&logo=gitter&style=flat-square" height="20" alt="Gitter chat"> |
22 | 19 | </a> |
23 | | - |
24 | | - <!-- Second row: --> |
25 | 20 | <br> |
26 | 21 | <a href="https://github.com/TheAlgorithms/Python/actions"> |
27 | 22 | <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 | 27 | <a href="https://docs.astral.sh/ruff/formatter/"> |
33 | 28 | <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 | 29 | </a> |
35 | | - |
36 | | -<!-- Short description: --> |
37 | | - <h3>All algorithms implemented in Python - for education 📚</h3> |
| 30 | + <h3>✨ All algorithms implemented in Python - for education 📚✨</h3> |
38 | 31 | </div> |
39 | 32 |
|
| 33 | +**Note** |
| 34 | +<br> |
40 | 35 | Implementations are for learning purposes only. They may be less efficient than the implementations in the Python standard library. Use them at your discretion. |
41 | | - |
42 | | -## 🚀 Getting Started |
43 | | - |
44 | | -📋 Read through our [Contribution Guidelines](CONTRIBUTING.md) before you contribute. |
45 | | - |
46 | | -## 🌐 Community Channels |
47 | | - |
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! |
49 | | - |
50 | | -## 📜 List of Algorithms |
51 | | - |
52 | | -See our [directory](DIRECTORY.md) for easier navigation and a better overview of the project. |
| 36 | +<br><br> |
| 37 | +## Getting Started |
| 38 | +- 📋 Read through our [Contribution Guidelines](CONTRIBUTING.md) before you contribute. |
| 39 | + |
| 40 | +<br><br> |
| 41 | + |
| 42 | +## 🛠 Usage Example |
| 43 | + |
| 44 | +Want to get started quickly? Follow these steps! |
| 45 | +<br><br> |
| 46 | +### 1. Clone the repository |
| 47 | +<br> |
| 48 | +<br> |
| 49 | +### 2. Run tests |
| 50 | +If tests are available, you can run them using: |
| 51 | + |
| 52 | +*Be sure to adjust the command if your test framework or folder structure is different.* |
| 53 | +<br> |
| 54 | +<br> |
| 55 | +### 3. Use an algorithm in Python |
| 56 | +Here’s how you might use the median finder: |
| 57 | + |
| 58 | +<br> |
| 59 | +<br> |
| 60 | +<br> |
| 61 | +--- |
| 62 | + |
| 63 | + Enjoy learning and contributing to open source algorithms! |
0 commit comments