@ -104,40 +104,48 @@ Configuration is done almost completely via global neovide variables in your vim
## Install
## Install
Relatively recent binaries can be found in the [project releases](https://github.com/Kethku/neovide/releases). But if you want the latest and greatest you should clone it and build yourself.
**Note**: 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 Vulkan-based, so driver support for Vulkan will be
necessary. On Windows this should be enabled by default if you have a relatively recent system.
Installing should be as simple as downloading the binary, making sure `nvim.exe` with version 0.4 or greater is on your path, and running it. Everything should be self contained.
**Note**: Neovide requires neovim version 0.4 or greater.
## Building
### From binary
Building instructions are somewhat limited at the moment. All the libraries I use are cross platform and should have
Relatively recent binaries can be found in the [project releases](https://github.com/Kethku/neovide/releases). But if you want the latest and greatest you should clone it and build yourself.
support for Windows, Mac, and Linux. The rendering however is Vulkan-based, so driver support for Vulkan will be
necessary. On Windows this should be enabled by default if you have a relatively recent system.
Note: Neovide requires neovim version 0.4 or greater.
Installing should be as simple as downloading the binary, making sure `nvim.exe` with version 0.4 or greater is on your path, and running it. Everything should be self contained.
### Windows
### Windows (from source)
1. Install the latest version of Rust. I recommend <https://rustup.rs/>
1. Install the latest version of Rust. I recommend <https://rustup.rs/>
2. Install CMake. I use chocolatey: `choco install cmake --installargs '"ADD_CMAKE_TO_PATH=System"' -y`
2. Install CMake. I use chocolatey: `choco install cmake --installargs '"ADD_CMAKE_TO_PATH=System"' -y`
3. Install LLVM. I use chocolatey: `choco install llvm -y`
3. Install LLVM. I use chocolatey: `choco install llvm -y`
4. Ensure graphics libraries are up to date.
4. Ensure graphics libraries are up to date.
5. `git clone https://github.com/Kethku/neovide`
5. Build and install Neovide:
6. `cd neovide`
7. `cargo build --release`
```sh
8. Copy `./target/release/neovide.exe` to a known location and enjoy.
git clone https://github.com/Kethku/neovide
cd neovide
cargo build --release
```
### Mac
6. Copy `./target/release/neovide.exe` to a known location and enjoy.
### Mac (from source)
1. Install the latest version of Rust. I recommend <https://rustup.rs/>
1. Install the latest version of Rust. I recommend <https://rustup.rs/>
2. Install CMake. Using homebrew: `brew install cmake`
2. Install CMake. Using homebrew: `brew install cmake`
3. Install the Vulkan SDK. I'm told `brew install apenngrace/vulkan/vulkan-sdk` works, but I can't test locally to find out.
3. Install the Vulkan SDK. I'm told `brew install apenngrace/vulkan/vulkan-sdk` works, but I can't test locally to find out.
4. `git clone https://github.com/Kethku/neovide`
4. Build and install Neovide:
5. `cd neovide`
6. `cargo build --release`
```sh
7. Copy `./target/release/neovide` to a known location and enjoy.
git clone https://github.com/Kethku/neovide
cd neovide
cargo build --release
```
Note: If you run into issues with the vulkan libraries being reported as not verified, this issue thread may help: https://github.com/Kethku/neovide/issues/167#issuecomment-593314579
5. Copy `./target/release/neovide` to a known location and enjoy.
### Linux
### Linux
@ -145,70 +153,75 @@ Note: If you run into issues with the vulkan libraries being reported as not ver
There is an [AUR package for neovide](https://aur.archlinux.org/packages/neovide-git/).
There is an [AUR package for neovide](https://aur.archlinux.org/packages/neovide-git/).
- Neovide requires that a font be set in `init.vim` otherwise errors might be encountered. This can be fixed by adding `set guifont=Your\ Font\ Name:h15` in init.vim file. Reference issue [#527](https://github.com/Kethku/neovide/issues/527).
- On OSX, if you run into issues with the vulkan libraries being reported as not verified, please reference issue [#167](https://github.com/Kethku/neovide/issues/167#issuecomment-593314579).
Note: If you run into libsndio errors, try building without default features which will disable static linking of the SDL
### Linux-specific
library.
- If you recieve an error of `SdlError("Installed Vulkan doesn't implement the VK_KHR_surface extension")`, please try installing the AMD Vulkan Driver (commonly, `amdvlk`). Reference issue [#209](https://github.com/Kethku/neovide/issues/209).
- If you recieve errors complaining about DRI3 settings, please reference issue [#44](https://github.com/Kethku/neovide/issues/44#issuecomment-578618052).
- If you recieve libsndio-related errors, try building without default features (this disables static linking of the SDL library).