Merge pull request #177 from curlpipe/0.6.10

0.6.10

Cargo.toml

@@ -7,7 +7,7 @@ exclude = ["cactus"]
 
 [package]
 name = "ox"
-version = "0.6.9"
+version = "0.6.10"
 edition = "2021"
 authors = ["Curlpipe <[email protected]>"]
 description = "A Rust powered text editor."
@@ -39,6 +39,6 @@ crossterm = "0.28.1"
 jargon-args = "0.2.7"
 kaolinite = { path = "./kaolinite" }
 mlua = { version = "0.9.9", features = ["lua54", "vendored"] }
-quick-error = "2.0.1"
+error_set = "0.6"
 shellexpand = "3.1.0"
 synoptic = "2.2.1"

README.md

@@ -40,7 +40,7 @@ If you're looking for a text editor that...
 
 It runs in your terminal as a text-user-interface, just like vim, nano and micro, however, it is not based on any existing editors and has been built from the ground up.
 
-It is mainly designed on linux systems, but macOS and Windows users (via WSL) are free to give it a go. Work is currently underway to get it working perfectly on all systems.
+It works best on linux, but macOS and Windows are also supported.
 
 ## Selling Points
 
@@ -71,64 +71,66 @@ It is mainly designed on linux systems, but macOS and Windows users (via WSL) ar
 
 - :globe_with_meridians: Handles double-width unicode characters like a charm, including those of the Chinese, Korean and Japanese languages and emojis
 - :boxing_glove: Backend has been thoroughly tested via automated unit tests
+- :rainbow: Automatically adapts your colour schemes to work on terminals with limited colours
 
 ## Installation
 
-> :warning: Huge Warning: A lot of these (except manual, AUR and homebrew) are quite out of date, it is quite a huge task having to push to all these sources each time I update and I'd rather focus on creating high-quality updates
+To get started, please click on your operating system
 
-### Prerequisites
+- :penguin: [Linux](#linux)
+- :window: [Windows](#windows)
+- :apple: [MacOS](#macos)
 
-Because Ox is written in Rust, you must have a modern and working version of `rustc` and `cargo`.
+### Linux
 
-On Arch Linux, you can run this command:
-```sh
-sudo pacman -S rustup
-rustup toolchain install stable
-```
+Here are the list of available methods for installing on Linux:
+- [Manually](#manual)
+- [Binary](#binaries)
+- [Arch Linux](#arch-linux)
+- [Fedora](#fedora)
+- [Debian / Ubuntu](#debian)
 
-If you are not using Arch, you can easily set it up on other distros by running the distro-neutral command:
-```sh
-curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
-/usr/bin/rustup toolchain install stable
-```
-You must have `curl` installed to run this command.
+#### Arch Linux
 
-### Installation Routes
+Install one of the following from the AUR:
+- `ox-bin` - install the pre-compiled binary (fastest)
+- `ox-git` - compile from source (best)
 
-#### Manual
+#### Fedora
 
-The absolute best way to install Ox, it will ensure you always have the latest version
+You can find an RPM in the [releases page](https://github.com/curlpipe/ox/releases)
 
-It should only really take at most 1 minute on most modern hardware.
+Install using the following command:
 
 ```sh
-cargo install --git https://github.com/curlpipe/ox ox
+sudo dnf install /path/to/rpm/file
 ```
 
-#### Arch Linux
+#### Debian
 
-Install `ox-bin` or `ox-git` from the Arch User Repository.
+You can find a deb file in the [releases page](https://github.com/curlpipe/ox/releases)
 
-That's all there is to it!
+Install using the following command:
 
-#### Fedora/CentOS
+```sh
+sudo dpkg -i /path/to/deb/file
+```
 
-Install `ox` from the [COPR Repository](https://copr.fedorainfracloud.org/coprs/atim/ox/): 
+### Windows
 
-```
-sudo dnf copr enable atim/ox -y
-sudo dnf install ox
-```
+Here are the list of available methods for installing on Windows:
+- [Manually (best)](#manual)
+- [Binary](#binaries)
 
-You can also find an RPM file in the releases page
 
-#### Debian
 
-You can find a deb file on the releases page, which can be installed via dpkg:
+### MacOS
 
-```sh
-dpkg -i ox_version.deb
-```
+Here are the list of available methods for installing on macOS:
+- [Manually](#manual)
+- [Binary](#binaries)
+- [Homebrew](#homebrew)
+- [MacPorts](#macports)
 
 #### Homebrew
 
@@ -147,6 +149,30 @@ sudo port selfupdate
 sudo port install ox
 ```
 
+### Binaries
+
+There are precompiled binaries available for all platforms in the [releases page](https://github.com/curlpipe/ox/releases).
+
+- For Linux: download the `ox` executable and copy it to `/usr/bin/ox`, then run `sudo chmod +x /usr/bin/ox`
+- For MacOS: download the `ox-macos` executable and copy it to `/usr/local/bin/ox`, then run `sudo chmod +x /usr/local/bin/ox`
+- For Windows: download the `ox.exe` executable and copy it into a location in `PATH` see [this guide](https://zwbetz.com/how-to-add-a-binary-to-your-path-on-macos-linux-windows/#windows-cli) for how to do it
+
+### Manual
+
+This is the absolute best way to install Ox, it will ensure you always have the latest version and everything works for your system.
+
+You must have a working installation of the Rust compiler to use this method. Visit the website for [rustup](https://rustup.rs/) and follow the instructions there for your operating system.
+
+Now with a working version of rust, you can run the command:
+
+```sh
+cargo install --git https://github.com/curlpipe/ox
+```
+
+This will take at worst around 2 minutes. On some more modern systems, it will take around 30 seconds.
+
+Please note that you should add `.cargo/bin` to your path, which is where the `ox` executable will live, although `rustup` will likely do that for you, so no need to worry too much.
+
 ## Quick Start Guide
 
 This is just a quick guide to help get you up to speed quickly with how to use the editor. You dive into more details in the documentation section below, but this quick start guide is a good place to start.