diff --git a/README.md b/README.md index 6c2c455..5a6c81a 100644 --- a/README.md +++ b/README.md @@ -6,29 +6,59 @@ Sunroof is a fork of [Vesktop](https://github.com/Vencord/Vesktop). -You can join our [discord server](https://discord.gg/VasF3Ma4Ab) for commits, changes, chat or even support.

- +You can join our [discord server](https://discord.gg/VasF3Ma4Ab) for commits, changes, chat or even support.

## Main features -- Much more lightweight and faster than the official Discord app -- Linux Screenshare with sound & wayland + +- Much more lightweight and faster than the official Discord app +- Linux Screenshare with sound & wayland **Extra included changes** -- Suncord preinstalled -- Custom Splash animations from [this PR](https://github.com/Vencord/Vesktop/pull/355) + +- Suncord preinstalled +- Custom Splash animations from [this PR](https://github.com/Vencord/Vesktop/pull/355) **Not yet supported**: -- Global Keybinds - + +- Global Keybinds ## Installing -Find the required installer you need [here](https://github.com/verticalsync/Sunroof/releases/latest). - +### Windows + +If you don't know the difference, pick the Installer. + +- [Installer](https://github.com/verticalsync/Sunroof/releases/latest/download/Sunroof-Setup-1.6.0.exe) +- [Portable](https://github.com/verticalsync/Sunroof/releases/latest/download/Sunroof-1.6.0-win.zip) + +### Mac + +If you don't know the difference, pick the Intel build. + +- [Intel build (amd64)](https://github.com/verticalsync/Sunroof/releases/latest/download/Sunroof-1.6.0.dmg) +- [Apple Silicon (arm64)](https://github.com/verticalsync/Sunroof/releases/latest/download/Sunroof-1.6.0-arm64.dmg) + +### Linux + +If you don't know the difference, pick amd64. + +- amd64 / x86_64 + - [AppImage](https://github.com/verticalsync/Sunroof/releases/latest/download/Sunroof-1.6.0.AppImage) + - [Ubuntu/Debian (.deb)](https://github.com/verticalsync/Sunroof/releases/latest/download/sunroof_1.6.0_amd64.deb) + - [Fedora/RHEL (.rpm)](https://github.com/verticalsync/Sunroof/releases/latest/download/sunroof-1.6.0.x86_64.rpm) + - [tarball](https://github.com/verticalsync/Sunroof/releases/latest/download/sunroof-1.6.0.tar.gz) +- arm64 / aarch64 + - [AppImage](https://github.com/verticalsync/Sunroof/releases/latest/download/Sunroof-1.6.0-arm64.AppImage) + - [Ubuntu/Debian (.deb)](https://github.com/verticalsync/Sunroof/releases/latest/download/sunroof_1.6.0_arm64.deb) + - [Fedora/RHEL (.rpm)](https://github.com/verticalsync/Sunroof/releases/latest/download/sunroof-1.6.0.aarch64.rpm) + - [tarball](https://github.com/verticalsync/Sunroof/releases/latest/download/sunroof-1.6.0-arm64.tar.gz) + ## Building from Source + Packaging will create builds in the dist/ folder + > [!NOTE] -> On Windows, You will get test errors about venmic, you can ignore these as it's a linux only module. +> On Windows, if you run the test script, you will get test errors about venmic, you can ignore these as it's a linux only module. ```sh git clone https://github.com/verticalsync/Sunroof