README: Update formatting (mostly, the linux section) (#618)

* Edit formatting for Windows/Mac installs

* Revamp the Linux build section

* Misc. formatting changes

* Merge build and install sections
macos-click-through
Daniel 4 years ago committed by GitHub
parent 764633d2ba
commit ba42855f4c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

@ -88,7 +88,7 @@ ssh -L 6666:localhost:6666 ip.of.other.machine nvim --headless --listen localhos
### Some Nonsense ;) ### Some Nonsense ;)
``` ```vim
let g:neovide_cursor_vfx_mode = "railgun" let g:neovide_cursor_vfx_mode = "railgun"
``` ```
@ -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/).
##### With Paru (or your preferred AUR helper)
```sh
paru -S neovide-git
```
##### Without helper
```sh ```sh
git clone https://aur.archlinux.org/neovide-git.git git clone https://aur.archlinux.org/neovide-git.git
cd neovide-git cd neovide-git
makepkg -si makepkg -si
``` ```
To install a non-default branch: ##### With non-default branch
```sh ```sh
git clone https://aur.archlinux.org/neovide-git.git git clone https://aur.archlinux.org/neovide-git.git
cd neovide-git cd neovide-git
nvim PKGBUILD REGEX=$(printf 's/{url}/&\#branch=%s/g' '<YOUR-BRANCH-HERE>')
:%s/l}/l}#branch=branch-name-here/ sed "$REGEX" PKGBUILD
:wq
makepkg -si makepkg -si
``` ```
Note: Neovide requires that a font be set in `init.vim` otherwise errors might be encountered. #### From source
See [#527](https://github.com/Kethku/neovide/issues/527) 1. Install necessary dependencies (adjust for your preferred package manager)
This can be fixed by adding `set guifont=Your\ Font\ Name:h15` in init.vim file.
#### Debian/Ubuntu
Note: Neovide has been successfully built on other distros but this reportedly works on ubuntu.
1. Install necessary dependencies
```sh ```sh
sudo apt-get install -y curl \ sudo apt install -y curl \
gnupg ca-certificates git \ gnupg ca-certificates git \
gcc-multilib g++-multilib cmake libssl-dev pkg-config \ gcc-multilib g++-multilib cmake libssl-dev pkg-config \
libfreetype6-dev libasound2-dev libexpat1-dev libxcb-composite0-dev \ libfreetype6-dev libasound2-dev libexpat1-dev libxcb-composite0-dev \
libbz2-dev libsndio-dev freeglut3-dev libxmu-dev libxi-dev libbz2-dev libsndio-dev freeglut3-dev libxmu-dev libxi-dev
``` ```
2. Install Vulkan SDK 2. Install Vulkan SDK (adjust for your preferred package manager, may already be in your repository)
```sh ```sh
curl -sL "http://packages.lunarg.com/lunarg-signing-key-pub.asc" | sudo apt-key add - curl -sL "http://packages.lunarg.com/lunarg-signing-key-pub.asc" | sudo apt-key add -
sudo curl -sLo "/etc/apt/sources.list.d/lunarg-vulkan-1.2.131-bionic.list" "http://packages.lunarg.com/vulkan/1.2.131/lunarg-vulkan-1.2.131-bionic.list" sudo curl -sLo "/etc/apt/sources.list.d/lunarg-vulkan-1.2.131-bionic.list" "http://packages.lunarg.com/vulkan/1.2.131/lunarg-vulkan-1.2.131-bionic.list"
sudo apt-get update -y sudo apt update -y
sudo apt-get install -y vulkan-sdk sudo apt install -y vulkan-sdk
``` ```
Alternatively if you are running an amd graphics card you may have more success by installing amdvlk.
https://github.com/Kethku/neovide/issues/209
3. Install Rust 3. Install Rust
`curl --proto '=https' --tlsv1.2 -sSf "https://sh.rustup.rs" | sh` ```sh
curl --proto '=https' --tlsv1.2 -sSf "https://sh.rustup.rs" | sh
```
4. Clone the repository 4. Clone the repository
`git clone "https://github.com/Kethku/neovide"` ```sh
git clone "https://github.com/Kethku/neovide"
```
5. Build 5. Build
`cd neovide && ~/.cargo/bin/cargo build --release` ```sh
cd neovide && ~/.cargo/bin/cargo build --release
```
6. Copy `./target/release/neovide` to a known location and enjoy. 6. Copy `./target/release/neovide` to a known location and enjoy.
If you see an error complaining about DRI3 settings, links in this issue may help: ## Troubleshooting
<https://github.com/Kethku/neovide/issues/44#issuecomment-578618052>. - 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).

Loading…
Cancel
Save