Merge pull request #108 from rahuliyer95/issue-106

Update README with build instructions for Ubuntu
macos-click-through
Keith Simmons 5 years ago committed by GitHub
commit 4f7f8654a6
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

@ -73,23 +73,40 @@ Note: Neovide requires neovim version 0.4 or greater.
### Linux
Note: Neovide has been compiled for multiple other distros, but the commands may need to be modified slightly to work.
1. Install `bzip2-devel` (or similar, depending on your distro)
2. Install Vulkan drivers. I'm not sure how on Linux. Id appreciate a PR if you know more :)
3. Depending on which libraries are already installed in the system, additonal libraries may need to be installed (Never
fear, we will do our best to add them here. Make an issue if you find one!)
4. If needed, install [vulkan-tools](https://github.com/LunarG/VulkanTools), etc. Information available in the
[vulkan](https://vulkan.lunarg.com/sdk/home) download page.
5. Download the [Vulkan SDK for Linux](https://vulkan.lunarg.com/sdk/home) and extract it in an easily accessible
location.
6. source /path/to//vulkansdk-linux-x86_64-1.1.130.0/1.1.130.0/setup-env.sh (version can change over time) in the shell
that will be used to compile `Neovide`
7. Install the latest version of Rust. I recommend <https://rustup.rs/>
8. `git clone https://github.com/Kethku/neovide`
9. `cd neovide`
10. `cargo build --release`
11. Copy `./target/release/neovide` to a known location and enjoy.
Instructions to build on Ubuntu
1. Install necessary dependencies
```sh
sudo apt-get 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 freeglut3-dev libxmu-dev libxi-dev
```
2. Install Vulkan SDK
```sh
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 apt-get update -y
sudo apt-get install -y vulkan-sdk
```
3. Install Rust
`curl --proto '=https' --tlsv1.2 -sSf "https://sh.rustup.rs" | sh`
4. Clone the repository
`git clone "https://github.com/Kethku/neovide"`
5. Build
`~/.cargo/bin/cargo build --release`
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:
<https://github.com/Kethku/neovide/issues/44#issuecomment-578618052>.

Loading…
Cancel
Save