Skip to content

Suggested README improvements to clarify scope and help new contributors #110

@thomgit9

Description

@thomgit9

Hi ,
I’ve found your repository very useful — thank you for making it open source.

While reading through the README, I took some time to improve the structure/clarity (mainly clarity, structure, content):

  • Replaces the existing short README with a comprehensive, structured document.
  • Introduces badges: GitHub Actions build, license, C++ standard, last commit.
  • Adds Quick Links: Documentation, Changelog, CI, Issues, Contributors.
  • Adds Repository Layout, Installation, Usage Overview, API Index, Build and Test, Versioning, License, and Contact sections.

I didn’t want to push directly on your repo without asking — so I created a fork to showcase what I mean.

You can review it here:
https://github.com/thomgit9/mp11/blob/develop/README.md

If you think some of these changes make sense, I’d be happy to open a PR.

Let me know if you’d like me to propose this as a PR directly.

Thanks again for the project — it’s been very helpful.

Best,

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions