Skip to content

Conversation

@yeshuawm999
Copy link

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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add “Usage Example” section to README

1 participant