mirror of
https://github.com/voideditor/void
synced 2026-05-24 09:58:23 +00:00
Update README with build instructions and project description
This commit is contained in:
parent
330ffd63f5
commit
7e57d601b8
1 changed files with 44 additions and 6 deletions
50
README.md
50
README.md
|
|
@ -1,15 +1,53 @@
|
|||
## Note
|
||||
# Void - Custom Fork
|
||||
|
||||
This is my fork of Void, to maintain my own version of Void, and keep updating the models and try to improve capabilities.
|
||||
## Description
|
||||
|
||||
## Reference
|
||||
This is my personal fork of **Void**, maintained to keep the project updated with the latest models and improvements.
|
||||
|
||||
Void 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).
|
||||
## Build Instructions
|
||||
|
||||
For a guide on how to develop your own version of Void, see [HOW_TO_CONTRIBUTE](https://github.com/voideditor/void/blob/main/HOW_TO_CONTRIBUTE.md) and [void-builder](https://github.com/voideditor/void-builder).
|
||||
To build Void from the command line, follow these steps:
|
||||
|
||||
### 1. Clone the Repository
|
||||
|
||||
```bash
|
||||
git clone https://github.com/jcommaret/void.git
|
||||
cd void
|
||||
```
|
||||
|
||||
### 2. Install Dependencies
|
||||
|
||||
```bash
|
||||
npm install
|
||||
```
|
||||
|
||||
### 3. Build the Project
|
||||
|
||||
```bash
|
||||
npm run buildreact
|
||||
npm run watch
|
||||
```
|
||||
|
||||
### 4. Start the Application
|
||||
|
||||
```bash
|
||||
./scripts/code.sh
|
||||
```
|
||||
|
||||
### 5. Build for macOS (ARM64)
|
||||
|
||||
```bash
|
||||
npm run gulp vscode-darwin-arm64
|
||||
```
|
||||
|
||||
## Support
|
||||
You can always reach us in our Discord server or contact us via email: hello@voideditor.com.
|
||||
|
||||
If you need help building your own version of Void or have any questions, feel free to reach me:
|
||||
|
||||
- **Discord**: [Join the community](https://discord.gg/xBRHsjn6Dn)
|
||||
|
||||
## Notes
|
||||
|
||||
- This is a custom fork with personal modifications
|
||||
- Regular updates are applied to keep the project current
|
||||
- Contributions and feedback are welcome
|
||||
|
|
|
|||
Loading…
Reference in a new issue