x11-misc/neovide.neovide
1
0
Fork 0
mirror of https://github.com/neovide/neovide.git synced 2026-09-10 07:16:25 -04:00
Code Issues Actions Packages Projects Releases Wiki Activity
No Nonsense Neovim Client in Rust
96 commits 38 branches 33 tags 115 MiB
Rust 96.4%
Handlebars 1.3%
Lua 1.2%
Shell 0.5%
CSS 0.3%
Other 0.3%
Go to file
Keith Simmons 436c334e39
Better mac and linux instructions
2020-01-26 14:40:19 -08:00
assets initial pass on readme 2020-01-25 17:14:57 -08:00
src minor using fix 2020-01-26 14:27:15 -08:00
.gitignore somewhat working with druid 2019-12-03 21:31:05 -08:00
.ok better cursor animation speed and clipping text to grid region 2019-12-30 16:17:05 -08:00
build.rs icons 2020-01-07 14:50:32 -08:00
Cargo.lock emojis working 2020-01-23 17:47:26 -08:00
Cargo.toml emojis working 2020-01-23 17:47:26 -08:00
README.md Better mac and linux instructions 2020-01-26 14:40:19 -08:00

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.

Basic Screen Cap

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.

Ligatures

Animated Cursor

Cursor animates into position with a smear effect to improve tracking of cursor position.

Animated Cursor

Emoji Support

Font fallback supports rendering of emoji not contained in the configured font.

Emoji

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

  1. Install latest version of rust. I recommend https://rustup.rs/
  2. Ensure graphics libraries are up to date.
  3. git clone https://github.com/Kethku/neovide
  4. cd neovide
  5. cargo build --release
  6. Copy ./targets/release/neovide.exe to a known location and enjoy.

Mac

  1. Install latest version of rust. I recommend https://rustup.rs/
  2. Install vulcan sdk. I'm told brew cask install apenngrace/vulkan/vulkan-sdk works, but I can't test locally to find out.
  3. git clone https://github.com/Kethku/neovide
  4. cd neovide
  5. cargo build --release
  6. Copy ./targets/release/neovide to a known location and enjoy.

Linux

  1. Install latest version of rust. I recommend https://rustup.rs/
  2. Install vulcan drivers. I'm not sure how on linux. Id appreciate a PR if you know more :)
  3. git clone https://github.com/Kethku/neovide
  4. cd neovide
  5. cargo build --release
  6. 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.