Enhance Documentation: Added "Usage Example" Section and Dedicated USAGE_EXAMPLE.md Guide #13729
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR enhances the repository’s documentation by adding a detailed “Usage Example” section and a new file named USAGE_EXAMPLE.md.
The goal is to help beginners and first-time contributors understand how to clone, run, test, and contribute to this repository more effectively.
🧠 What’s New
📝 1. New Section in README
Added a new “Usage Examples” section below the main content.
This section provides:
Step-by-step guide to clone and explore the repo.
📄New File: USAGE_EXAMPLE.md
A standalone, detailed version of the usage guide for easier access.
Includes:
Installation and setup instructions
Folder walkthrough
Running algorithms with examples
Unit testing commands
Steps to add a new algorithm (template included)
PR and contribution workflow summary
List of potential algorithm ideas for contribution
This file acts as a “Getting Started + How to Contribute” manual for new developers.
Fixes issue #13714