diff --git a/README.md b/README.md index 301a2d62..c4917974 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,26 @@ -# GNvim - Neovim GUI with rust and gtk +# GNvim - Rich Neovim GUI without any web bloat -Highly experimental. +Gnvim is still in active development! That said, I've used it daily for the +past 6 months, both at work and for developing gnvim. [Find some screenshots here](https://github.com/vhakulinen/gnvim/wiki) +## Features + +* No electron (!), build on GTK. +* Ligatures +* Custom cursor tooltip feature to display markdown documents. + Useful for implementing features like hover information or signature help + (see [gnvim-lsp](https://github.com/vhakulinen/gnvim-lsp)). +* A lot of the nvim external features implemented + - Popupmenu + * Own view for `preview` (`:h completeopt`). + - Tabline + - Cmdline + - Wildmenu + +More externalized features will follow as they are implemented for neovim. + ## Requirements GNvim requires @@ -32,3 +49,5 @@ you can use `--nvim` flag (e.g. `gnvim --nvim=/path/to/nvim`). For debugging purposes, there is `--print-nvim-cmd` flag to tell gnvim to print the executed nvim command. + +See `gnvim --help` for all the cli arguments.