Commit 926d2f44 authored by Campbell Jones's avatar Campbell Jones 💬
Browse files

Update README

parent 1965a976
......@@ -16,7 +16,7 @@ Wraith Master supports all 64-bit Linux distributions that use glibc as their li
## Installing
There are precompiled binaries available for each release [here](https://gitlab.com/serebit/wraith-master/-/releases). Some Linux distributions have alternate installation methods, which are detailed below.
#### Arch/Derivatives
......@@ -26,44 +26,13 @@ If you're on Arch Linux or one of its derivatives, you can install both frontend
Solus has both frontends in the official repository. They can be installed either by running `sudo eopkg it wraith-master` in the terminal, or searching for the package in the Software Center.
## Screenshots
![Screenshot][wraith-master-screenshot]
## Building from Source
### Build Dependencies
In addition to a Java Developer Kit (JDK) of version 8 or newer, Wraith Master requires the following packages to build:
| Distribution | Shared Dependencies | GTK-Only |
|--------------------|---------------------------------------------------|------------------|
| Debian/Derivatives | `libusb-1.0-0-dev`, `gcc-multilib`, `libncurses5` | `libgtk-3-dev` |
| Arch/Derivatives | `ncurses5-compat-libs` (AUR) | `gtk3` |
| Fedora | `libusbx-devel`, `ncurses-compat-libs` | `gtk3-devel` |
| OpenSUSE | `libusb-1_0-devel`, `libncurses5` | `gtk3-devel` |
| Solus | `libusb-devel` | `libgtk-3-devel` |
| Gentoo | `dev-libs/libusb`, `ncurses-compat` | `gtk+` |
You'll need the packages in Shared Dependencies to build Wraith Master, but if you're only building the command-line frontend, you don't need the packages in GTK-Only.
#### Other Distributions
### Instructions
There are precompiled binaries available for each release [here](https://gitlab.com/serebit/wraith-master/-/releases).
Each Gradle command that follows can be run with the subproject name as a prefix in order to only build and install specific artifacts. For instance, `:cli:package` would build the command line artifact, and `:gtk:package` would build the GTK artifact.
To build all artifacts and place them in the `build/package` directory, run the following:
```bash
./gradlew package
```
To install the built artifacts and their associated resources, run the following:
```bash
./gradlew install
```
## Screenshots
This will install the packages in `/usr/local` by default. To change the installation directory, pass a parameter to the above task in the format `-Pinstalldir="/your/install/dir"`. You can also change the directory that the udev rules will be installed in by passing the parameter `-Pudevdir="/your/udev/dir"` (the rules are installed to `/etc/udev` by default). You can also disable the installation of udev rules entirely by passing the parameter `-Pnoudev`, although this argument is automatically applied on Linux distributions that don't use udev.
![Screenshot][wraith-master-screenshot]
## Runtime Dependencies
......@@ -74,7 +43,11 @@ This will install the packages in `/usr/local` by default. To change the install
| Fedora | None | `gtk3` |
| OpenSUSE | None | `glib2`, `gtk3` |
| Solus | None | None |
| Gentoo | `dev-libs/libusb` | Untested |
| Gentoo | `dev-libs/libusb` | `gtk+` |
## Building from Source
See [this section of the wiki](https://gitlab.com/serebit/wraith-master/-/wikis/building-from-source) for instructions on building this software yourself.
## Changelog
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment