ankit02327/nvim-cpp-setup

Revise and Modernise README.md

Open

#4 opened on Aug 29, 2025

View on GitHubContributor guide
 (0 comments) (0 reactions) (1 assignee)Lua (0 forks)auto 404
documentationenhancementgood first issue

Repository metrics

Stars
 (4 stars)
PR merge metrics
 (PR metrics pending)

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

Research direction
Create a modern README with screenshots, a demo video, badges, and structured sections. Use Neovim plugin README patterns.
Tech stack
lua
Domain
developer experiencetooling
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitMarkdown
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80