ankit02327 / ankit02327/nvim-config

Update and Modernise README.md

Aperta
#2 0 commenti 0 reazioni 1 assegnatario Rivendicata da @ankit02327 Vedi su GitHub
documentation enhancement
Lingua principale
Lua
Stelle
3
Fork
0
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

The current README.md contains detailed information about features and structure, but it’s overwhelming and lacks clear usage instructions for quick on-boarding. A streamlined, modernised README would make the project far more accessible.

Suggested Improvements
- Screenshots & GIFs
- Show the configuration in action (before/after comparison).
- Add a quick GIF for workflows (e.g., fuzzy finding, LSP integration, file explorer toggle).
- Demo Video
- A short video walking through setup and everyday usage (compile & run, navigation, etc.).
- Modern README Components
- Badges (Neovim version, License, Stars).
- Clear, minimal installation & usage instructions at the top.
- Collapsible sections for advanced configuration.
- Concise, bulleted feature overview.
- Visual Enhancements
- Simple diagrams/graphs showing modular config structure or plugin architecture.
- Flowchart of how startup works with lazy.nvim.
- Support & Community
- Add “Support this project” section (e.g., Buy Me a Coffee / GitHub Sponsors).
- Clear contributing guidelines link.

This update will make the README:
- Readable for newcomers in 1–2 minutes.
- Actionable with quick copy-paste install steps.
- Engaging with visuals that demonstrate value.

⚡ By doing this, the README will reflect the polish of the configuration itself and help attract more users & contributors.

Guida per i contributori

Apri la guida per i contributori

Valutazione

Questa issue non è ancora stata valutata.

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.