Merge pull request #108 from rahuliyer95/issue-106

Update README with build instructions for Ubuntu

README.md

@@ -5,11 +5,11 @@ functionally like the terminal UI.
 
 ![Basic Screen Cap](./assets/BasicScreenCap.png)
 
-I've been using this as my daily driver since November 2019. It should be relatively stable, but I'm still working out some kinks 
+I've been using this as my daily driver since November 2019. It should be relatively stable, but I'm still working out some kinks
-and ironing out some cross platform issues. In general it should be usable at this point, and if it isn't I consider that a bug and 
+and ironing out some cross platform issues. In general it should be usable at this point, and if it isn't I consider that a bug and
 appreciate a report in the issues! Any help and ideas are also greatly appreciated.
 
-I'm also very interested in suggestions code quality/style wise when it comes to Rust. I'm pretty new to the language and appreciate 
+I'm also very interested in suggestions code quality/style wise when it comes to Rust. I'm pretty new to the language and appreciate
 any critiques that you might have to offer. I won't take all of them, but I promise to consider anything you might have to offer.
 
 ## Features
@@ -40,7 +40,7 @@ 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 
+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` with version 0.4 or greater is on your path, and running it. Everything should be self contained.
@@ -73,26 +73,43 @@ 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.
+Instructions to build on Ubuntu
-
+
-1. Install `bzip2-devel` (or similar, depending on your distro)
+1. Install necessary dependencies
-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
+    ```sh
-   fear, we will do our best to add them here. Make an issue if you find one!)
+    sudo apt-get install -y curl \
-4. If needed, install [vulkan-tools](https://github.com/LunarG/VulkanTools), etc. Information available in the 
+        gnupg ca-certificates git \
-   [vulkan](https://vulkan.lunarg.com/sdk/home) download page.
+        gcc-multilib g++-multilib cmake libssl-dev pkg-config \
-5. Download the [Vulkan SDK for Linux](https://vulkan.lunarg.com/sdk/home) and extract it in an easily accessible
+        libfreetype6-dev libasound2-dev libexpat1-dev libxcb-composite0-dev \
-   location.
+        libbz2-dev freeglut3-dev libxmu-dev libxi-dev
-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/>
+2. Install Vulkan SDK
-8. `git clone https://github.com/Kethku/neovide`
+
-9. `cd neovide`
+    ```sh
-10. `cargo build --release`
+    curl -sL "http://packages.lunarg.com/lunarg-signing-key-pub.asc" | sudo apt-key add -
-11. Copy `./target/release/neovide` to a known location and enjoy.
+    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
-If you see an error complaining about DRI3 settings, links in this issue may help: 
+    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>.
 
-Note: Currently some people seem to be encountering problems with Wayland: <https://github.com/aclysma/skulpin/issues/36>. 
+Note: Currently some people seem to be encountering problems with Wayland: <https://github.com/aclysma/skulpin/issues/36>.
 Any help would be appreciated.