diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6078ff92fe..1601369b37 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,6 +2,8 @@ ## Initial Setup +### macOS / Linux + You'll need the following tools installed on your system: ``` @@ -21,6 +23,28 @@ Initial setup to install dependencies for Vite+: just init ``` +### Windows + +You'll need the following tools installed on your system. You can use [winget](https://learn.microsoft.com/en-us/windows/package-manager/). + +```powershell +winget install pnpm.pnpm OpenJS.NodeJS.LTS Casey.Just Kitware.CMake +``` + +Install Rust & Cargo from [rustup.rs](https://rustup.rs/), then install `cargo-binstall`: + +```powershell +cargo install cargo-binstall +``` + +Initial setup to install dependencies for Vite+: + +```powershell +just init +``` + +**Note:** Run commands in PowerShell or Windows Terminal. Some commands may require elevated permissions. + ## Build Vite+ and upstream dependencies To create a release build of Vite+ and all upstream dependencies, run: diff --git a/justfile b/justfile index 0966abe028..67dd2e2203 100644 --- a/justfile +++ b/justfile @@ -8,8 +8,15 @@ _default: alias r := ready -init: +[unix] +_clean_dist: rm -rf packages/*/dist + +[windows] +_clean_dist: + Remove-Item -Path 'packages/*/dist' -Recurse -Force -ErrorAction SilentlyContinue + +init: _clean_dist cargo binstall watchexec-cli cargo-insta typos-cli cargo-shear dprint taplo-cli -y node packages/tools/src/index.ts sync-remote pnpm install