diff --git a/HOW_TO_CONTRIBUTE.md b/HOW_TO_CONTRIBUTE.md index 693ddd5c..3aa9ea6e 100644 --- a/HOW_TO_CONTRIBUTE.md +++ b/HOW_TO_CONTRIBUTE.md @@ -12,7 +12,7 @@ There are a few ways to contribute: ### Codebase Guide -We [highly recommend reading this](https://github.com/voideditor/void/blob/main/VOID_CODEBASE_GUIDE.md) guide that we put together on Void's sourcecode if you'd like to contribute! +We [highly recommend reading this](https://github.com/voideditor/void/blob/main/VOID_CODEBASE_GUIDE.md) guide that we put together on Void's sourcecode if you'd like to add new features. The repo is not as intimidating as it first seems if you read the guide! @@ -52,17 +52,18 @@ First, run `npm install -g node-gyp`. Then: ### d. Building Void from inside VSCode -To build Void, open `void/` inside VSCode. Then open your terminal and run: - -1. `npm install` to install all dependencies. -2. Build Void. - - Press Cmd+Shift+B (Mac). - - Press Ctrl+Shift+B (Windows/Linux). +1. `git clone https://github.com/voideditor/void` to clone the repo. +2. `npm install` to install all dependencies. +3. To build Void, open VSCode. Then: + - Windows: Press Ctrl+Shift+B. + - Mac: Press Cmd+Shift+B. + - Linux: Press Ctrl+Shift+B. - This step can take ~5 min. The build is done when you see two check marks (one of the items will continue spinning indefinitely - it compiles our React code). -3. Run Void. - - Run `./scripts/code.sh` (Mac/Linux). - - Run `./scripts/code.bat` (Windows). -4. Nice-to-knows. +4. To run Void: + - Windows: `./scripts/code.bat`. + - Mac: `./scripts/code.sh`. + - Linux: `./scripts/code.sh`. +5. Nice-to-knows. - You can always press Ctrl+R (Cmd+R) inside the new window to reload and see your new changes. It's faster than Ctrl+Shift+P and `Reload Window`. - You might want to add the flags `--user-data-dir ./.tmp/user-data --extensions-dir ./.tmp/extensions` to the above run command, which lets you delete the `.tmp` folder to reset any IDE changes you made when testing. - You can kill any of the build scripts by pressing `Ctrl+D` in VSCode terminal. If you press `Ctrl+C` the script will close but will keep running in the background (to open all background scripts, just re-build). @@ -85,6 +86,7 @@ To build Void from the terminal instead of from inside VSCode, follow the steps - Make sure you followed the prerequisite steps above. - Make sure you have Node version `20.18.2` (the version in `.nvmrc`)! +- Make sure that the path to your Void folder does not have any spaces in it. - If you get `"TypeError: Failed to fetch dynamically imported module"`, make sure all imports end with `.js`. - If you get an error with React, try running `NODE_OPTIONS="--max-old-space-size=8192" npm run buildreact`. - If you see missing styles, wait a few seconds and then reload. diff --git a/README.md b/README.md index a4467387..106882c9 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,7 @@ Void is the open-source Cursor alternative. -This repo contains the full sourcecode for Void. We are currently in [open beta](https://voideditor.com/email) for Discord members (see the `announcements` channel), with a waitlist for our official release. If you're new, welcome! +This repo contains the full sourcecode for Void. If you're new, welcome! - 👋 [Discord](https://discord.gg/RSNjgaugJs) @@ -25,16 +25,16 @@ This repo contains the full sourcecode for Void. We are currently in [open beta] ## Contributing -1. Feel free to attend a weekly meeting in our Discord channel if you'd like to contribute! +1. To get started working on Void, see [`HOW_TO_CONTRIBUTE`](https://github.com/voideditor/void/blob/main/HOW_TO_CONTRIBUTE.md). -2. To get started working on Void, see [`HOW_TO_CONTRIBUTE`](https://github.com/voideditor/void/blob/main/HOW_TO_CONTRIBUTE.md). +2. Feel free to attend a weekly meeting in our Discord channel! 3. We're open to collaborations and suggestions of all types - just reach out. ## Reference -Void is a fork of the [vscode](https://github.com/microsoft/vscode) repository. For a guide to the VSCode/Void codebase, see [`VOID_CODEBASE_GUIDE`](https://github.com/voideditor/void/blob/main/VOID_CODEBASE_GUIDE.md). +[Void](https://voideditor.com) is a fork of the [vscode](https://github.com/microsoft/vscode) repository. For a guide to the codebase, see [`VOID_CODEBASE_GUIDE`](https://github.com/voideditor/void/blob/main/VOID_CODEBASE_GUIDE.md). ## Support -Feel free to reach out in our Discord or contact us via email: hello@voideditor.com. +You can always reach us in our Discord server or contact us via email: hello@voideditor.com. diff --git a/VOID_CODEBASE_GUIDE.md b/VOID_CODEBASE_GUIDE.md index 34a665be..14a04686 100644 --- a/VOID_CODEBASE_GUIDE.md +++ b/VOID_CODEBASE_GUIDE.md @@ -132,25 +132,24 @@ If you want to know how our build pipeline works, see our build repo [here](http ## VSCode Codebase Guide -The Void team put together this list of links to get up and running with VSCode's sourcecode, the foundation of Void. We hope it's helpful! +For additional references, the Void team put together this list of links to get up and running with VSCode. +
+ #### Links for Beginners - [VSCode UI guide](https://code.visualstudio.com/docs/getstarted/userinterface) - covers auxbar, panels, etc. - - [UX guide](https://code.visualstudio.com/api/ux-guidelines/overview) - covers Containers, Views, Items, etc. #### Links for Contributors - [How VSCode's sourcecode is organized](https://github.com/microsoft/vscode/wiki/Source-Code-Organization) - this explains where the entry point files are, what `browser/` and `common/` mean, etc. This is the most important read on this whole list! We recommend reading the whole thing. - - [Built-in VSCode styles](https://code.visualstudio.com/api/references/theme-color) - CSS variables that are built into VSCode. Use `var(--vscode-{theme but replacing . with -})`. You can also see their [Webview theming guide](https://code.visualstudio.com/api/extension-guides/webview#theming-webview-content). #### Misc - [Every command](https://code.visualstudio.com/api/references/commands) built-in to VSCode - not used often, but here for reference. - - Note: VSCode's repo is the source code for the Monaco editor! An "editor" is a Monaco editor, and it shares the code for ITextModel, etc. @@ -159,13 +158,10 @@ The Void team put together this list of links to get up and running with VSCode' Void is no longer an extension, so these links are no longer required, but they might be useful if we ever build an extension again. - [Files you need in an extension](https://code.visualstudio.com/api/get-started/extension-anatomy). - - [An extension's `package.json` schema](https://code.visualstudio.com/api/references/extension-manifest). - - ["Contributes" Guide](https://code.visualstudio.com/api/references/contribution-points) - the `"contributes"` part of `package.json` is how an extension mounts. - - [The Full VSCode Extension API](https://code.visualstudio.com/api/references/vscode-api) - look on the right side for organization. The [bottom](https://code.visualstudio.com/api/references/vscode-api#api-patterns) of the page is easy to miss but is useful - cancellation tokens, events, disposables. - - [Activation events](https://code.visualstudio.com/api/references/activation-events) you can define in `package.json` (not the most useful). +