Python icon indicating copy to clipboard operation
Python copied to clipboard

Added Usage Example section to README (Fixes #13714)

Open yeshuawm999 opened this issue 2 months ago • 2 comments

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:

  • [x] Documentation change

Checklist:

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

yeshuawm999 avatar Nov 07 '25 17:11 yeshuawm999

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?

yeshuawm999 avatar Nov 09 '25 17:11 yeshuawm999

Hi! Just checking in 🙂 All tasks are completed and the PR is ready for review. Please let me know if any changes are needed — happy to update!

yeshuawm999 avatar Nov 13 '25 16:11 yeshuawm999