From a3c1233e301bb713a6a1d4f88f63ec69c8c79806 Mon Sep 17 00:00:00 2001 From: Keith Simmons Date: Mon, 27 Jan 2020 12:56:55 -0800 Subject: [PATCH] update readme and move skulpin to track upstream github instead of published package --- Cargo.lock | 3 +-- Cargo.toml | 2 +- README.md | 47 ++++++++++++++++++++++++++++++++--------------- 3 files changed, 34 insertions(+), 18 deletions(-) diff --git a/Cargo.lock b/Cargo.lock index 5e85cb4..98c7bba 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -2255,8 +2255,7 @@ dependencies = [ [[package]] name = "skulpin" version = "0.5.1" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "05fe5761e1abdb580a9255255f2cdb41382263e2fd3e5e03e681e5486f8b4f58" +source = "git+https://github.com/aclysma/skulpin#c0b194833f97b839bd44a30fc2f17851b14e1016" dependencies = [ "ash", "cocoa", diff --git a/Cargo.toml b/Cargo.toml index eab2604..5e08caa 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -10,7 +10,7 @@ euclid = "0.20.7" font-kit = "0.4.0" skribo = { git = "https://github.com/linebender/skribo" } lru = "0.4.3" -skulpin = "0.5.1" +skulpin = { git = "https://github.com/aclysma/skulpin" } derive-new = "0.5" env_logger = "0.7.1" rmpv = "0.4.2" diff --git a/README.md b/README.md index b41ac43..b8f13c1 100644 --- a/README.md +++ b/README.md @@ -5,9 +5,12 @@ 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 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'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 +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 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. +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 @@ -37,9 +40,11 @@ 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 hoping to automate and produce Mac and Linux binaries as well, but I haven't gotten there yet. +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` is on your path, and running it. Everything should be self contained. +Installing should be as simple as downloading the binary, making sure `nvim.exe` is on your path, and running it. Everything +should be self contained. ## Building @@ -65,16 +70,28 @@ necessary. On Windows this should be enabled by default if you have a relatively 5. `cargo build --release` 6. Copy `./targets/release/neovide` to a known location and enjoy. -### Linux (Probably Ubuntu, your millage may vary) +### Linux -1. Install the latest version of Rust. I recommend -2. Install Vulkan drivers. I'm not sure how on Linux. Id appreciate a PR if you know more :) -3. Install libgtk: `sudo apt install libgtk-3-dev` -4. `git clone https://github.com/Kethku/neovide` -5. `cd neovide` -6. `cargo build --release` -7. Copy `./targets/release/neovide` to a known location and enjoy. +Note: Neovide has been compiled for multiple other distros, but the commands may need to be modified slightly to work. -If you see an error complaining about DRI3 settings, links in this issue may help: . - -Note: Currently there seems to be problems with Wayland: . Any help would be appreciated. +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 +8. `git clone https://github.com/Kethku/neovide` +9. `cd neovide` +10. `cargo build --release` +11. Copy `./targets/release/neovide` to a known location and enjoy. + +If you see an error complaining about DRI3 settings, links in this issue may help: +. + +Note: Currently some people seem to be encountering problems with Wayland: . +Any help would be appreciated.