docs(readme-gui): add build requirements

This commit is contained in:
anatawa12 2024-03-03 20:26:44 +09:00
commit 5be32841d1
No known key found for this signature in database
GPG key ID: 9CA909848B8E4EA6

View file

@ -8,6 +8,22 @@ The recommended way to install vrc-get-gui is download from [GitHub Releases][vr
[vrc-get-gui-releases]: https://github.com/anatawa12/vrc-get/releases?q=gui-v0
## Requirements (building)
To build vrc-get-gui, you need to have the following installed:
- [Node.js] v20 (to build the web part of the project)
- [npm] (to install the dependencies of the web part)
- [cargo] (to build the Rust part of the project)
- [cargo-about] (to generate the licenses json)
- [.NET SDK] v8 (to build vrc-get-litedb crate)
[Node.js]: https://nodejs.org/en
[npm]: https://www.npmjs.com
[cargo]: https://doc.rust-lang.org/cargo/
[cargo-about]: https://github.com/EmbarkStudios/cargo-about
[.NET SDK]: https://dotnet.microsoft.com/download
## Building
To build the project, run the following command: