Browse Source

docs: Add crueter suggestions

Signed-off-by: Caio Oliveira <caiooliveirafarias0@gmail.com>
pull/2993/head
Caio Oliveira 3 months ago
committed by crueter
parent
commit
42ed048be7
  1. 6
      docs/Build.md
  2. 2
      docs/Deps.md
  3. 13
      tools/windows/install-vulkan-sdk.sh

6
docs/Build.md

@ -62,13 +62,13 @@ Hit "Configure Project", then wait for CMake to finish configuring (may take a w
> - `tools/windows/load-msvc-env.ps1` (for PowerShell 5+)
> - `tools/windows/load-msvc-env.sh` (for MSYS2, Git Bash, etc)
Availables `<GENERATOR>`:
Available `<GENERATOR>`:
- MSYS2: `MSYS Makefiles`
- MSVC: `Ninja` (preferred) or `Visual Studio 17 2022`
- macOS: `Ninja` (preferred) or `Xcode`
- Others: `Ninja` (preferred) or `UNIX Makefiles`
Availables `<BUILD_TYPE>`:
Available `<BUILD_TYPE>`:
- `Release` (default)
- `RelWithDebInfo` (debug symbols--compiled executable will be large)
- `Debug` (if you are using a debugger and annoyed with stuff getting optimized out)
@ -151,7 +151,7 @@ Simply hit Ctrl+B, or the "hammer" icon in the bottom left. To run, hit the "pla
### On Command Line
If you are using the `UNIX Makefiles` or `Visual Studio 17 2022` as `<GENERATOR>`, you must also want to add `--parallel $(nproc)` to this command to improve building time.
If you are using the `UNIX Makefiles` or `Visual Studio 17 2022` as `<GENERATOR>`, you should also add `--parallel` for faster build times.
```
cmake --build build

2
docs/Deps.md

@ -27,7 +27,7 @@ The following additional tools are also required:
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
- If you wish to use Qt Creator, append `qtcreator` or `qt-creator` to the commands seen below.
* MSVC/clang-cl users on Windows must install through the official [Qt 6](https://www.qt.io/download-qt-installer-oss) installer
* MSVC/clang-cl users on Windows must install through the official [Qt](https://www.qt.io/download-qt-installer-oss) installer
* Linux and macOS users may choose to use the installer as well.
* MSYS2 can also install Qt 6 via the package manager

13
tools/windows/install-vulkan-sdk.sh

@ -23,15 +23,8 @@ echo "Installing Vulkan SDK $VULKAN_SDK_VER..."
if net session > /dev/null 2>&1; then
./$EXE_FILE --root "$VULKAN_ROOT" --accept-licenses --default-answer --confirm-command install
else
DESTINATION=$(cygpath -w "$PWD/$EXE_FILE")
powershell.exe -Command "
Start-Process \"$DESTINATION\" -Verb RunAs -ArgumentList @(
'--root', '$VULKAN_ROOT',
'--accept-licenses',
'--default-answer',
'--confirm-command',
'install'
)"
echo "This script must be run with administrator privileges!"
exit 1
fi
echo "Finished installing Vulkan SDK $VULKAN_SDK_VER"
@ -40,4 +33,4 @@ echo "Finished installing Vulkan SDK $VULKAN_SDK_VER"
if [ \"${GITHUB_ACTIONS:-false}\" = \"true\" ]; then
echo \"VULKAN_SDK=$VULKAN_ROOT\" >> \"$GITHUB_ENV\"
echo \"$VULKAN_ROOT/bin\" >> \"$GITHUB_PATH\"
fi
fi
Loading…
Cancel
Save