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

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

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

wants to merge 2 commits into from

Conversation

@yeshuawm999
Copy link

@yeshuawm999 yeshuawm999 commented Nov 7, 2025

Describe your change:

Added a new “Usage Example” section to the README.md file.
This section explains how users can clone the repository, run algorithms locally, use the Python interactive shell, and run doctests.
It improves the documentation for beginners and new contributors.

Fixes #13714

Type of change:

  • Documentation change

Checklist:

  • I have read CONTRIBUTING.md.
  • This pull request is all my own work -- I have not plagiarized.
  • I know that pull requests will not be merged if they fail the automated tests.
  • This PR only modifies the README.md file.
  • The Markdown style matches the existing format (emoji headers, indentation, and code blocks).
  • The new section helps users understand how to clone, run, and test algorithms from the repository.
  • The section includes properly formatted fenced code blocks for commands.
  • This PR improves project usability for new contributors.

@algorithms-keeper algorithms-keeper bot added documentation This PR modified documentation files awaiting reviews This PR is ready to be reviewed labels Nov 7, 2025
pipineitor
pipineitor approved these changes Nov 9, 2025
View reviewed changes
Copy link

@pipineitor pipineitor left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the code is good but I don't speak English am use a translator of Google

@yeshuawm999
Copy link
Author

yeshuawm999 commented Nov 9, 2025

the code is good but I don't speak English am use a translator of Google

So,What do you want exactly from me to merge my pr?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

1 more reviewer

@pipineitor pipineitor pipineitor approved these changes

Reviewers whose approvals may not affect merge requirements

At least 1 approving review is required to merge this pull request.

Assignees

No one assigned

Labels

awaiting reviews This PR is ready to be reviewed documentation This PR modified documentation files

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Add “Usage Example” section to README

2 participants

@yeshuawm999 @pipineitor