ankit02327 / ankit02327/nvim-cpp-setup

Revise and Modernise README.md

Open
#4 0 comments 0 reactions 1 assignee Claimed by @ankit02327 View on GitHub
documentation enhancement good first issue
Dominant language
Lua
Stars
4
Forks
0
PR merge metrics
No merged PRs in 30d

Description

**The current README.md is outdated, long, and non-functional. It needs a complete revision to better showcase the plugin and make it easier for users to understand and adopt.**

Improvements Needed
- Add screenshots that show how the plugin looks in action (for example, before/after, with and without the plugin).
- Include a short demo video that demonstrates usage, such as compiling and running code with a single key-press.
- Update the structure to include modern README components: badges, concise installation instructions, collapsible sections, and a clean feature list.
- Add simple graphs or visuals to illustrate workflows, performance benefits, or the overall plugin architecture.
- Provide a support link (e.g., Buy Me a Coffee or something related) for users who want to contribute to ongoing development.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.