Skip to content

Enhance README.md: formatting, clarity, and educational notes #13873

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
ABHIRANJAN-KUMAR1 wants to merge 5 commits into
base: master
Choose a base branch
from
Open

Enhance README.md: formatting, clarity, and educational notes #13873

ABHIRANJAN-KUMAR1 wants to merge 5 commits into from

Conversation

@ABHIRANJAN-KUMAR1
Copy link

@ABHIRANJAN-KUMAR1 ABHIRANJAN-KUMAR1 commented Nov 6, 2025

This PR improves the README.md for better readability and clarity. Changes include:

  • Updated headings and badges
  • Polished "Getting Started" section
  • Improved "List of Algorithms" section
  • Added clear educational disclaimer
  • Minor formatting and spacing fixes

All changes follow the CONTRIBUTING.md guidelines.

ABHIRANJAN-KUMAR1
ABHIRANJAN-KUMAR1 commented Nov 13, 2025
View reviewed changes
Copy link
Author

@ABHIRANJAN-KUMAR1 ABHIRANJAN-KUMAR1 left a comment •
edited
Loading

Choose a reason for hiding this comment

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

Hey maintainers 👋 All checks have passed and one approval is already in. If another reviewer could take a moment to review and approve, this PR can be merged 😊 Thanks a lot!

@algorithms-keeper algorithms-keeper bot mentioned this pull request Nov 14, 2025
Closed
15 tasks
@algorithms-keeper algorithms-keeper bot added the awaiting reviews This PR is ready to be reviewed label Nov 22, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@mindaugl mindaugl Awaiting requested review from mindaugl

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

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@ABHIRANJAN-KUMAR1 @mindaugl