From 604578bb1941c84f8a9f61a4a58896a2fbefdadc Mon Sep 17 00:00:00 2001 From: Andrew Pareles Date: Wed, 20 Nov 2024 22:32:58 -0800 Subject: [PATCH] update contrib --- CONTRIBUTING.md | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f06d13d1..2a5ec462 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -9,11 +9,10 @@ There are a few ways to contribute: - Submit Issues/Docs/Bugs ([Issues](https://github.com/voideditor/void/issues)) -## 2. Building the IDE +## Building the full IDE Please follow the steps below to build the IDE. If you have any questions/issues, you can refer to VSCode's full [How to Contribute](https://github.com/microsoft/vscode/wiki/How-to-Contribute) page. Also feel free to [submit an issue](https://github.com/voideditor/void/issues/new) or get in touch with us with any build errors. - ### a. Build Prerequisites - Mac @@ -38,12 +37,17 @@ Finally, click Install. ### c. Build Prerequisites - Linux -We haven't created prerequisite steps for building on Linux yet, but you can follow [How to Contribute](https://github.com/microsoft/vscode/wiki/How-to-Contribute). +First, make sure you've installed NodeJS and run `npm install -g node-gyp`. Then: + +- Debian (Ubuntu, etc) - `sudo apt-get install build-essential g++ libx11-dev libxkbfile-dev libsecret-1-dev libkrb5-dev python-is-python3`. + +- Red Hat (Fedora, etc) - `sudo dnf install @development-tools gcc gcc-c++ make libsecret-devel krb5-devel libX11-devel libxkbfile-devel`. + +- Others - see [How to Contribute](https://github.com/microsoft/vscode/wiki/How-to-Contribute). ### Build instructions Before building Void, please follow the prerequisite steps above for your operating system. Also, make sure you've already built and compiled the Void React components by running `cd ./` (or just run `cd ./extensions/void && npm install && npm run build && npm run compile && cd ../..`). - To build Void, first open `void/` in VSCode. Then: 1. Install all dependencies.