Skip to content
This repository has been archived by the owner on Jul 29, 2024. It is now read-only.

Commit

Permalink
update ze readme
Browse files Browse the repository at this point in the history
  • Loading branch information
verticalsync committed Jun 7, 2024
1 parent e6ae5cd commit 5457253
Showing 1 changed file with 41 additions and 11 deletions.
52 changes: 41 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.<br></br>

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

## 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
Expand Down

0 comments on commit 5457253

Please sign in to comment.