436c334e39 | 5 years ago | |
---|---|---|
assets | 5 years ago | |
src | 5 years ago | |
.gitignore | 5 years ago | |
.ok | 5 years ago | |
Cargo.lock | 5 years ago | |
Cargo.toml | 5 years ago | |
README.md | 5 years ago | |
build.rs | 5 years ago |
README.md
Neovide
This is a simple graphical user interface for Neovim. Where possible there are some graphical improvements, but it should act functionally like the terminal UI.
Features
Should be a standard full features Neovim GUI. Beyond that there are some visual nicities:
Ligatures
Supports ligatures and full Harbuzz backed font rendering.
Animated Cursor
Cursor animates into position with a smear effect to improve tracking of cursor position.
Emoji Support
Font fallback supports rendering of emoji not contained in the configured font.
More to Come
I've got more ideas for simple unobtrusive improvements. More to come.
Install
Currently there is just a windows binary under the project releases https://github.com/Kethku/neovide/releases. I'm hoping to automate and produce mac and linux binaries as well, but I haven't gotten there yet.
Installing should be as simple as downloading the binary, making sure nvim.exe
is on your path, and running it. Everything should be self contained.
Building
Building instructions are somewhat limited at the moment. All the libraries I use are cross platform and should have support for Windows Mac and Linux. The rendering however is Vulcan based, so driver support for vulcan will be necessary. On Windows this should be enabled by default if you have a relatively recent system.
Windows
- Install latest version of rust. I recommend https://rustup.rs/
- Ensure graphics libraries are up to date.
git clone https://github.com/Kethku/neovide
cd neovide
cargo build --release
- Copy
./targets/release/neovide.exe
to a known location and enjoy.
Mac
- Install latest version of rust. I recommend https://rustup.rs/
- Install vulcan sdk. I'm told
brew cask install apenngrace/vulkan/vulkan-sdk
works, but I can't test locally to find out. git clone https://github.com/Kethku/neovide
cd neovide
cargo build --release
- Copy
./targets/release/neovide
to a known location and enjoy.
Linux
- Install latest version of rust. I recommend https://rustup.rs/
- Install vulcan drivers. I'm not sure how on linux. Id appreciate a PR if you know more :)
git clone https://github.com/Kethku/neovide
cd neovide
cargo build --release
- Copy
./targets/release/neovide
to a known location and enjoy.
Note: Currently there seems to be problems with wayland https://github.com/aclysma/skulpin/issues/36. Any help would be appreciated.