You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

3.9 KiB

Raw Blame History

Installation

Note: Neovide requires neovim version 0.6 or greater. See previous releases such as 0.5.0 if your distro is too slow with updating or you need to rely on older neovim versions.

Building instructions are somewhat limited at the moment. All the libraries Neovide uses are cross platform and should have support for Windows, Mac, and Linux. The rendering is based on OpenGL, so a good GPU driver will be necessary, the default drivers provided by virtual machines might not be enough. On Windows this should be enabled by default if you have a relatively recent system.

Binaries

Installing should be as simple as downloading the binary, making sure the nvim executable with version 0.6 or greater is on your PATH environment variable, and running it. Everything should be self contained.

The binaries are to be found on the release page.

Windows

Scoop

Scoop has Neovide in the extras bucket. Ensure you have the extras bucket, and install:

$ scoop bucket list
main
extras

$ scoop install neovide

Windows Source

Install the latest version of Rust. I recommend https://rustup.rs/
Install CMake. I use chocolatey: choco install cmake --installargs '"ADD_CMAKE_TO_PATH=System"' -y
Install LLVM. I use chocolatey: choco install llvm -y
Ensure graphics libraries are up to date.
Build and install Neovide:
```
cargo install --git https://github.com/neovide/neovide.git
```
The resulting binary can be found inside of ~/.cargo/bin afterwards (99% of the time).

Mac

Homebrew

Neovide is available as Cask in Homebrew. It can be installed from the command line:

brew install --cask neovide

Mac Source

Install the latest version of Rust. Using homebrew: brew install rustup-init
Configure rust by running rustup-init
Install CMake. Using homebrew: brew install cmake
git clone https://github.com/neovide/neovide
cd neovide
cargo install --path .

The resulting binary is to be found under ~/.cargo/bin. In case you want a nice application bundle:
cargo install cargo-bundle
cargo bundle --release
Copy ./target/release/bundle/osx/neovide.app to ~/Applications and enjoy.

Linux

Arch Linux

Stable releases are packaged in the community repository.

pacman -S neovide

To run a development version you can build from the VCS package in the AUR. This can be built and installed using an AUR helper or by hand in the usual way. To build from a non-default branch you can edit the PKGBUILD and add #branch-name to the end of the source URL.

Snap

Neovide is also available in the Snap Store. You can install it using the command below.

snap install neovide

Linux Source

Install necessary dependencies (adjust for your preferred package manager, probably most of this stuff is already installed, just try building and see)

sudo apt install -y curl \
    gnupg ca-certificates git \
    gcc-multilib g++-multilib cmake libssl-dev pkg-config \
    libfreetype6-dev libasound2-dev libexpat1-dev libxcb-composite0-dev \
    libbz2-dev libsndio-dev freeglut3-dev libxmu-dev libxi-dev libfontconfig1-dev

Install Rust

curl --proto '=https' --tlsv1.2 -sSf "https://sh.rustup.rs" | sh

Fetch and build
```
cargo install --git https://github.com/neovide/neovide
```
The resulting binary can be found inside of ~/.cargo/bin afterwards, you might want to add this to your PATH environment variable.

3.9 KiB Raw Blame History