Verified Commit 0cbb15ed authored by Campbell Jones's avatar Campbell Jones 💬
Browse files

Update README.md

parent 60c722a0
Pipeline #193174135 passed with stage
in 1 minute and 37 seconds
![Wraith Master][wraith-master-logo]
[![Pipeline Status][pipeline-status]](https://gitlab.com/serebit/wraith-master/commits/master)
[![GitLab][gitlab-badge]](https://gitlab.com/serebit/wraith-master)
[![GitHub Mirror][github-badge]](https://github.com/serebit/wraith-master)
[![CI Pipeline Status][pipeline-status-badge]](https://gitlab.com/serebit/wraith-master/commits/master)
[![License][license-badge]](https://www.apache.org/licenses/LICENSE-2.0.html)
[![Ko-fi][kofi-badge]](https://ko-fi.com/serebit)
......@@ -10,13 +12,23 @@ Wraith Master is a feature-complete graphical and command-line application for c
Designed for feature parity with the official Windows-only Cooler Master application, Wraith Master supports all modes and settings that the Wraith Prism can use. As the Wraith coolers are capable of storing RGB configurations in-device, no daemon is required to maintain configurations, and the program can be uninstalled without fear of losing your settings.
![Screenshot][wraith-master-screenshot]
## Supported Platforms
Wraith Master supports all 64-bit Linux distributions that use glibc as their libc implementation. This dependence on glibc is not my choice, but a limitation of the software stack; Kotlin/Native is [incompatible with musl](https://github.com/JetBrains/kotlin-native/issues/3771) as of the time I am writing this. Once it gains compatibility with more libc implementations, I fully intend to take advantage of that compatibility. Check out [issue #3](https://gitlab.com/serebit/wraith-master/-/issues/3) for more details.
## Installing
#### Arch/Derivatives
#### Debian/Ubuntu and Derivatives
Prebuilt `.deb` packages are available on the Releases page on both GitLab and GitHub.
#### Fedora and Derivatives
Prebuilt `.rpm` packages are available on the Releases page on both GitLab and GitHub.
#### Arch and Derivatives
If you're on Arch Linux or one of its derivatives, you can install both frontends [from the AUR](https://aur.archlinux.org/packages/?K=wraith%2Dmaster). If you'd rather not build from source, you'll want to install `wraith-master-bin`; otherwise, it's under `wraith-master-cli` for the CLI frontend and `wraith-master-gtk` for the GTK frontend.
......@@ -26,11 +38,7 @@ Solus has both frontends in the official repository. They can be installed eithe
#### Other Distributions
There are precompiled binaries available for each release [here](https://gitlab.com/serebit/wraith-master/-/releases). For versions 1.0.0 and newer, prebuilt packages for Ubuntu/Debian and Fedora are also available on the releases page.
## Screenshots
![Screenshot][wraith-master-screenshot]
There are precompiled binaries available for each release [here](https://gitlab.com/serebit/wraith-master/-/releases), with all binaries and resources included.
## Runtime Dependencies
......@@ -61,7 +69,12 @@ See `CHANGELOG.md` for notes on previous releases, along with changes that are c
## License
Wraith Master is open-sourced under the [Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0.html).
Wraith Master is open-sourced under the [Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0.html). All contributions to this repository will be subject to this license.
## In the News
- [Phoronix: Wraith Master 1.0 Released For Controlling AMD RGB Fans On Linux](https://www.phoronix.com/scan.php?page=news_item&px=Wraith-Master-1.0), by Michael Larabel
- [Gaming On Linux: Take control of your AMD Wraith Prism RGB on Linux with Wraith Master](https://www.gamingonlinux.com/2020/08/take-control-of-your-amd-wraith-prism-rgb-on-linux-with-wraith-master), by Liam Dawe
## Acknowledgements
......@@ -72,7 +85,9 @@ Wraith Master is open-sourced under the [Apache License, Version 2.0](https://ww
- **AMD**, for including actually decent stock coolers with their desktop processors.
[wraith-master-logo]: https://serebit.com/images/wraith-master-banner-nopad.svg "Wraith Master"
[pipeline-status]: https://gitlab.com/serebit/wraith-master/badges/master/pipeline.svg "Pipeline Status"
[gitlab-badge]: https://img.shields.io/badge/-gitlab-6e49cb?logo=gitlab "GitLab"
[github-badge]: https://img.shields.io/badge/-github-505050?logo=github "GitLab"
[pipeline-status-badge]: https://gitlab.com/serebit/wraith-master/badges/master/pipeline.svg "Pipeline Status"
[license-badge]: https://img.shields.io/badge/License-Apache%202.0-lightgrey.svg "License"
[kofi-badge]: https://img.shields.io/badge/-ko--fi-ff5f5f?logo=ko-fi&logoColor=white "Ko-fi"
[wraith-master-screenshot]: https://serebit.com/images/wraith-master-screenshot.png "Screenshot"
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