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

Commit

Permalink
README Revamp
Browse files Browse the repository at this point in the history
  • Loading branch information
verysillycat authored Apr 7, 2024
1 parent 36cbd8d commit f80d0b1
Showing 1 changed file with 19 additions and 6 deletions.
25 changes: 19 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,30 @@
![logo](./static/icon.png)

# Sunroof

Sunroof is a [Vesktop](https://github.com/Vencord/Vesktop) fork
[![Sunroof](https://img.shields.io/badge/Suncord-orange?style=flat)](https://github.com/verticalsync/Suncord)
[![Tests](https://github.com/verticalsync/Sunroof/actions/workflows/test.yml/badge.svg?branch=main)](https://github.com/verticalsync/Sunroof/actions/workflows/test.yml)
[![Discord](https://img.shields.io/discord/1207691698386501634.svg?color=768AD4&label=Discord&logo=discord&logoColor=white)](https://discord.gg/VasF3Ma4Ab)

## Installing
Sunroof is a fork of [Vesktop](https://github.com/Vencord/Vesktop)

Find the required installer you need [here](https://github.com/verticalsync/Sunroof/releases/tag/latest).
**Main features**:
- Suncord preinstalled
- Much more lightweight and faster than the official Discord app
- Linux Screenshare with sound & wayland
- Custom Splash animations from [this PR](https://github.com/Vencord/Vesktop/pull/355)

## Windows contribution
**Not yet supported**:
- Global Keybinds


You will get test errors about venmic, you can ignore these as it's a linux only module.
You can join our [discord server](https://discord.gg/VasF3Ma4Ab) for commits, changes, chat or even support.

## Building from Source
## Installing

Find the required installer you need [here](https://github.com/verticalsync/Sunroof/releases).

## Building from Source
Packaging will create builds in the dist/ folder

```sh
Expand Down

0 comments on commit f80d0b1

Please sign in to comment.