Skip to content

Added Usage Example section to README (Fixes #13714) #13884

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Added Usage Example section to README (Fixes #13714) #13884

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cc96235
Added Usage Example section to README (Fixes #13714)
yeshuawm999 Nov 7, 2025
1f879d2
Merge branch 'master' into add-usage-example-readme-v2
yeshuawm999 Nov 7, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,3 +50,20 @@ We are on [Discord](https://the-algorithms.com/discord) and [Gitter](https://git
## 📜 List of Algorithms

See our [directory](DIRECTORY.md) for easier navigation and a better overview of the project.
## 🧩 Usage Example

Here’s how you can clone this repository and run algorithms locally:

1. **Clone the repository**
```bash
git clone https://github.com/TheAlgorithms/Python.git
cd Python
2. **Run an algorithm**
python3 path/to/algorithm.py
3. **Use the interactive Python shell**
python3
>>> from algorithms.category import algorithm_name
>>> algorithm_name(arguments)
4. **Run doctests to verify correctness**
python3 -m doctest -v path/to/algorithm.py