mirrors/vrc-get
2
0
Fork 0
mirror of https://github.com/vrc-get/vrc-get.git synced 2026-06-21 09:58:08 +00:00
Code Issues Projects Releases Packages Wiki Activity
vrc-get/CONTRIBUTING.md
anatawa12 3411b13336
 chore: change node.js version in README
2025-03-03 22:57:16 +09:00

1.6 KiB
Raw Blame History

Contributing

First, thank you for considering contributing to this project.

This project consists of multiple projects. Each project may have its own contribution guidelines, so please read the CONTRIBUTING.md file in the project folder.

Setup development environment

System configuration requirements

This project is generally based on Rust, so you need to install Rust to work with this project.

Please refer to the Rust installation guide to install Rust if you don't have it.

This project is constantly updated to the latest stable version of Rust,
so it is recommended to install with rustup and update it regularly.

Not only Rust, some projects may require additional dependencies.

For ALCOM, you need to install Node.js >=20 supported and npm for building the frontend.

Please refer to the Node.js installation guide to install Node.js if you don't have it.

Clonging requirements

To set up your project, use the following commands.

git clone https://github.com/vrc-get/vrc-get.git
# or
git clone --recurse-submodules https://github.com/vrc-get/vrc-get.git

You can work on any OS system, but this repository generally uses Symbolic Links.

For Windows machines, you may need to set up so your current user can create symbolic links. Please refer to git-for-windows documentation page https://github.com/git-for-windows/git/wiki/Symbolic-Links