Improve README

This commit is contained in:
Tiagoquix 2024-05-08 11:47:58 -03:00 committed by GitHub
parent d11a9a04ff
commit f117f9dea2
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -1,16 +1,16 @@
# Vesktop # Vesktop
Vesktop is a custom Discord desktop app Vesktop is a custom Discord desktop app.
**Main features**: **Main features**:
- Vencord preinstalled - Vencord pre-installed.
- Much more lightweight and faster than the official Discord app - Much more lightweight and faster than the official Discord app.
- Linux Screenshare with sound & wayland - Linux screenshare with sound and Wayland compatibility.
- Much better privacy, since Discord has no access to your system - Much better privacy, since Discord has no access to your system.
**Not yet supported**: **Not yet supported**:
- Global Keybinds - Global keybinds
- see the [Roadmap](https://github.com/Vencord/Vesktop/issues/324) - For other things, see the [roadmap](https://github.com/Vencord/Vesktop/issues/324).
![](https://github.com/Vencord/Vesktop/assets/45497981/8608a899-96a9-4027-9725-2cb02ba189fd) ![](https://github.com/Vencord/Vesktop/assets/45497981/8608a899-96a9-4027-9725-2cb02ba189fd)
![](https://github.com/Vencord/Vesktop/assets/45497981/8701e5de-52c4-4346-a990-719cb971642e) ![](https://github.com/Vencord/Vesktop/assets/45497981/8701e5de-52c4-4346-a990-719cb971642e)
@ -19,12 +19,12 @@ Vesktop is a custom Discord desktop app
### Windows ### Windows
If you don't know the difference, pick the Installer. We recommend the installer.
- [Installer](https://vencord.dev/download/vesktop/amd64/windows) - [Installer](https://vencord.dev/download/vesktop/amd64/windows)
- [Portable](https://vencord.dev/download/vesktop/amd64/windows-portable) - [Portable](https://vencord.dev/download/vesktop/amd64/windows-portable)
### Mac ### MacOS
If you don't know the difference, pick the Intel build. If you don't know the difference, pick the Intel build.
@ -33,16 +33,20 @@ If you don't know the difference, pick the Intel build.
### Linux ### Linux
Flathub provides both `amd64` (`x86_64`) and `arm64` (`aarch64`) builds on a single standalone.
[![Download on Flathub](https://dl.flathub.org/assets/badges/flathub-badge-en.svg)](https://flathub.org/apps/dev.vencord.Vesktop) [![Download on Flathub](https://dl.flathub.org/assets/badges/flathub-badge-en.svg)](https://flathub.org/apps/dev.vencord.Vesktop)
If you don't know the difference, pick amd64. If you prefer a native package for your distribution, check the list below.
To check which version is appropriate for you, type `uname -m` in a terminal window.
- amd64 / x86_64 - `amd64` (`x86_64`)
- [AppImage](https://vencord.dev/download/vesktop/amd64/appimage) - [AppImage](https://vencord.dev/download/vesktop/amd64/appimage)
- [Ubuntu/Debian (.deb)](https://vencord.dev/download/vesktop/amd64/deb) - [Ubuntu/Debian (.deb)](https://vencord.dev/download/vesktop/amd64/deb)
- [Fedora/RHEL (.rpm)](https://vencord.dev/download/vesktop/amd64/rpm) - [Fedora/RHEL (.rpm)](https://vencord.dev/download/vesktop/amd64/rpm)
- [tarball](https://vencord.dev/download/vesktop/amd64/tar) - [tarball](https://vencord.dev/download/vesktop/amd64/tar)
- arm64 / aarch64
- `arm64` (`aarch64`)
- [AppImage](https://vencord.dev/download/vesktop/arm64/appimage) - [AppImage](https://vencord.dev/download/vesktop/arm64/appimage)
- [Ubuntu/Debian (.deb)](https://vencord.dev/download/vesktop/arm64/deb) - [Ubuntu/Debian (.deb)](https://vencord.dev/download/vesktop/arm64/deb)
- [Fedora/RHEL (.rpm)](https://vencord.dev/download/vesktop/arm64/rpm) - [Fedora/RHEL (.rpm)](https://vencord.dev/download/vesktop/arm64/rpm)
@ -50,13 +54,13 @@ If you don't know the difference, pick amd64.
#### Community packages #### Community packages
Below you can find unofficial packages created by the community. They are not officially supported by us, so before reporting issues, please first confirm the issue also happens on official builds. When in doubt, consult with their packager first. The flatpak and AppImage should work on any distro that [supports them](https://flatpak.org/setup/), so I recommend you just use those instead! There are unofficial packages created by the community. They are not officially supported by us; so, before reporting issues, please first confirm the issue also happens on official builds. When in doubt, consult with their packager first. The Flatpak and AppImage should work on any distro that [supports them](https://flatpak.org/setup/), so I recommend you just use those instead!
- Arch Linux: [Vesktop on the Arch user repository](https://aur.archlinux.org/packages?K=vesktop) - Arch Linux: [Vesktop on the Arch User Repository (AUR)](https://aur.archlinux.org/packages?K=vesktop)
- NixOS: https://nixos.wiki/wiki/Discord#Vesktop - NixOS: https://nixos.wiki/wiki/Discord#Vesktop
- Windows - Scoop: https://scoop.sh/#/apps?q=Vesktop - Windows (via Scoop): https://scoop.sh/#/apps?q=Vesktop
## Building from Source ## Building from source
Packaging will create builds in the dist/ folder Packaging will create builds in the dist/ folder
@ -64,7 +68,7 @@ Packaging will create builds in the dist/ folder
git clone https://github.com/Vencord/Vesktop git clone https://github.com/Vencord/Vesktop
cd Vesktop cd Vesktop
# Install Dependencies # Install dependencies
pnpm i pnpm i
# Either run it without packaging # Either run it without packaging