chore(readme): rewrote it for new version

This commit is contained in:
DarthMooMancer committed 2026-10-31 02:19:43 -04:00
1 parent 51e911ec33
commit 15f3648af8
1 file changed
+25 -25
+25 -25
View File
@@ -1,54 +1,54 @@
<h1 align="center">Vern.nvim</h1>
<h1 align="center">Vern-nvim</h1>
<p align="center"><em>Vern.nvim or Vernacular.nvim is a multi lingual project manager. It creates new projects and files from templates, builds and runs code and can run language specific functions within Neovim</em></p>
<p align="left">Vern-nvim (aka Vernacular-nvim) is a multilingual project scaffolder with a bunch of extra add-ons. It creates new projects, new files based on buffer filetype, runs projects and builds if needed and more.</p>
<p align="center">
<img src="https://img.shields.io/badge/Lua-1e90ff?style=for-the-badge&logo=lua&logoColor=white" />
<img src="https://img.shields.io/badge/Neovim-0.10%2B-32c48d?style=for-the-badge&logo=neovim&logoColor=white" />
<img src="https://img.shields.io/badge/License-MIT-yellow.svg?style=for-the-badge" />
<!-- <img src="https://img.shields.io/badge/Docs-Available-blue?style=for-the-badge&logo=readthedocs&logoColor=white" /> -->
</p>
> [!WARNING]
> Vern-nvim is only tested on vim.pack as of right now.
> Meaning it may not work well with lazy.nvim or any other package manager
NOTE: The plugin may not work well with lazy or any other package manager other than vim.pack. I dont understand enough about nvim api and lua to handle these other things right now
> [!NOTE]
> This is solely a passion project to improve my own workflow meaning that the plugin is very opinionated. If it were to ever pickup traction, I would love it if people could suggest larger changes that allowed this to be an even better neovim project scaffold
## Features
* Create projects directly from Neovim
* Generate new files quickly
* Build your code with customizable build systems
* Run programs without leaving the editor
* Integrated terminal for flexible command execution
* Minimal configuration with extensibility in mind
* Works out of the box with no additional configuration needed
* Extensibility towards custom templates.
* Custom commands
* Builtin terminal for viewing code !(scratchpad in future)
* !(Future) Allows for custom providers for languages and custom commands
> 📚 [View the full documentation](https://git.moomancer.xyz/DarthMooMancer/vern-nvim.nvim/wiki/Home$0) for setup, configuration, and usage details.
> All features and configs are documented here [Future Documentation](https://vern-nvim.moomancer.xyz/docs) (lies, it will be here one day)
## Supported Languages
Vern.nvim currently supports the following languages:
Vern-nvim currently supports the following languages:
* Python
* C / C++
* Lua
* Java
<!-- * Rust -->
<!-- * HTML -->
* Rust
Additional language support is planned for future releases.
- Web based languages (HTML, CSS, JS/TS), these will be scaffolded by deno, bun, etc
- Other languages I am interested in
## Roadmap
Current focus:
* **Refactoring and internal cleanup.**
- [ ] Refactoring and internal cleanup from v1.
- [ ] Implement scratchpad functionality
- [ ] Impleemtn custom provider support
- [ ] Keybinds for specific languages to rebuild (c/c++/java/rust) (Part 1)
- [ ] Adding language specific keybinds for extra information or convienence (Part 2)
## Contributing
Contributions are welcome and appreciated.
Contributions are welcome and appreciated!
* Open an issue for bug reports, questions, or feature requests.
* Submit a pull request if you'd like to contribute directly.
If you have an idea or use case you'd like to see supported, let’s discuss it.
Your feedback and contributions are key to making Vern.nvim even better! Thank you for being part of the journey. 🙏
Thank you for checking out Vern-nvim!