devproje/project-client
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Add Build & Install instructions

Browse source
This commit is contained in:
Vendicated 2023-04-04 03:35:31 +02:00
parent 0296f78731
commit f9ebc16656
No known key found for this signature in database
GPG key ID: A1DC0CFB5615D905
1 changed files with 49 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

50
README.md
View file

@ -1,6 +1,54 @@
# Vencord Desktop
A standalone Electron app that loads Discord & Vencord (very early and unfinished)
A standalone Electron app that loads Discord & Vencord
Vencord Desktop is currently in very early alpha. Bug reports, feature requests & contributions are highly appreciated!!
## Installing
### Windows
Download and run Vencord-Desktop-Setup-VERSION.exe from [releases](https://github.com/Vencord/Desktop/releases/latest)
### Mac
Download and run Vencord-Desktop-VERSION.dmg from [releases](https://github.com/Vencord/Desktop/releases/latest)
### Linux
#### Ubuntu/Debian based
Download Vencord-Desktop-VERSION.deb from [releases](https://github.com/Vencord/Desktop/releases/latest)
#### Fedora/RHEL based
Download Vencord-Desktop-VERSION.rpm from [releases](https://github.com/Vencord/Desktop/releases/latest)
#### Other
Either download Vencord-Desktop-VERSION.AppImage and just run it directly or grab Vencord-Desktop-VERSION.tar.gz, extract it somewhere and run `vencorddesktop`.
An AUR package and flatpak are planned, if you want packages for other repos, feel free to create them and they can be linked as unofficial here
## Building
Packaging will create builds in the dist/ folder. You can then install them like mentioned above or distribute them
```sh
git clone https://github.com/Vencord/Desktop
cd Desktop
# Install Dependencies
pnpm i
# Either run it without packaging
pnpm start
# Or package
pnpm package
# Or package to a directory only
pnpm package:dir
```
## Motivation