Browse Source

[docs] introduce our shell scripts

Signed-off-by: Caio Oliveira <caiooliveirafarias0@gmail.com>
pull/2993/head
Caio Oliveira 3 months ago
committed by crueter
parent
commit
33be95c794
  1. 3
      docs/Build.md
  2. 4
      docs/Deps.md

3
docs/Build.md

@ -59,7 +59,8 @@ Hit "Configure Project", then wait for CMake to finish configuring (may take a w
>On Windows: >On Windows:
> - It's recommended to install **[Ninja](https://ninja-build.org/)** > - It's recommended to install **[Ninja](https://ninja-build.org/)**
> - You must load **Visual C++ development environment**, this can be done by running our convenience script: > - You must load **Visual C++ development environment**, this can be done by running our convenience script:
> - `tools/windows/load-msvc-env.ps1`
> - `tools/windows/load-msvc-env.ps1` (for PowerShell 5+)
> - `tools/windows/load-msvc-env.sh` (for MSYS2, Git Bash, etc)
Availables `<GENERATOR>`: Availables `<GENERATOR>`:
- MSYS2: `MSYS Makefiles` - MSYS2: `MSYS Makefiles`

4
docs/Deps.md

@ -20,7 +20,9 @@ The following additional tools are also required:
- **[Windows installer](https://gitforwindows.org)** - **[Windows installer](https://gitforwindows.org)**
* **[Python3](https://www.python.org/downloads/)** 3.10+ - necessary to download external repositories * **[Python3](https://www.python.org/downloads/)** 3.10+ - necessary to download external repositories
* On Windows, you must install the **[Vulkan SDK](https://vulkan.lunarg.com/sdk/home#windows)** as well * On Windows, you must install the **[Vulkan SDK](https://vulkan.lunarg.com/sdk/home#windows)** as well
- *A convenience script to install the latest SDK is provided in `tools/windows/install-vulkan-sdk.ps1`*
- *A convenience script to install the latest SDK is provided in:*
- `tools/windows/install-vulkan-sdk.ps1` (for PowerShell 5+)
- `tools/windows/install-vulkan-sdk.sh` (for MSYS2, Git Bash, etc)
If you are on desktop and plan to use the Qt frontend, you *must* install Qt 6, and optionally Qt Creator (the **RECOMMENDED** IDE for building) If you are on desktop and plan to use the Qt frontend, you *must* install Qt 6, and optionally Qt Creator (the **RECOMMENDED** IDE for building)
* On Linux, *BSD and macOS, this can be done by the package manager * On Linux, *BSD and macOS, this can be done by the package manager

Loading…
Cancel
Save