Skip to content

Commit bfc4731

Browse files
committed
docs: update Windows build instructions
1 parent 7a767e9 commit bfc4731

File tree

1 file changed

+32
-19
lines changed

1 file changed

+32
-19
lines changed

README.md

Lines changed: 32 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -41,13 +41,28 @@ source code.
4141

4242
## Compiling
4343

44-
Dependencies: Embree 3.0+, TBB (TODO: version?), Sphinx (for building manuals)
44+
Required dependencies:
45+
- [Embree 4](https://github.com/RenderKit/embree)
46+
- [oneTBB](https://github.com/uxlfoundation/oneTBB)
47+
48+
Optional dependencies:
49+
- Python, Sphinx (for building manuals)
50+
- Qt 6 (for `lightpreview` GUI)
51+
52+
Bundled dependencies:
53+
- [fmt](https://github.com/fmtlib/fmt)
54+
- [jsoncpp](https://github.com/open-source-parsers/jsoncpp)
55+
- [nanobench](https://github.com/martinus/nanobench)
56+
- [pareto](https://github.com/alandefreitas/pareto)
57+
- [GoogleTest](https://github.com/google/googletest)
58+
- [stb_image](https://github.com/nothings/stb/blob/master/stb_image.h)
59+
- [stb_image_write](https://github.com/nothings/stb/blob/master/stb_image_write.h)
4560

4661
### Ubuntu 24.04
4762

4863
NOTE: Builds using Ubuntu's embree packages produce a significantly slower `light` (i.e. over twice as slow) than ones released on Embree's GitHub. See `build-linux-64.sh` for a better method.
4964

50-
```
65+
```bash
5166
sudo apt update
5267
sudo apt install libembree-dev libtbb-dev cmake build-essential g++ qt6-base-dev
5368
git clone --recursive https://github.com/ericwa/ericw-tools
@@ -67,34 +82,32 @@ make -j 8
6782
./lightpreview/lightpreview
6883
```
6984

70-
### Windows
85+
### Windows, obtaining required dependencies via vcpkg
7186

72-
Example using vcpkg (32-bit build):
87+
Open a `cmd` window. First, obtain vcpkg and build the dependencies:
7388

89+
```bat
90+
git clone https://github.com/microsoft/vcpkg
91+
cd vcpkg
92+
.\bootstrap-vcpkg.bat
93+
.\vcpkg.exe install embree tbb
94+
cd ..
7495
```
75-
git clone --recursive https://github.com/ericwa/ericw-tools
76-
cd ericw-tools
7796

78-
# creates a python virtual environment in the directory `sphinx-venv`
79-
# and install sphinx (for building the docs)
80-
py.exe -m venv sphinx-venv
81-
.\sphinx-venv\Scripts\Activate.ps1
82-
py.exe -m pip install -r docs/requirements.txt
97+
Next, clone and build ericw-tools:
8398

84-
git clone https://github.com/microsoft/vcpkg
85-
.\vcpkg\bootstrap-vcpkg.bat
99+
```bat
100+
git clone --recursive https://github.com/ericwa/ericw-tools
101+
cd ericw-tools
86102
87-
# NOTE: vcpkg builds for 32-bit by default
88-
# NOTE: takes 30+ minutes
89-
.\vcpkg\vcpkg install embree3
90103
mkdir build
91104
cd build
92105
93-
# PowerShell syntax for getting current directory -
94-
# otherwise, replace with absolute path to "vcpkg/scripts/buildsystems/vcpkg.cmake"
95-
cmake .. -DCMAKE_TOOLCHAIN_FILE="$(pwd)/../vcpkg/scripts/buildsystems/vcpkg.cmake" -DCMAKE_GENERATOR_PLATFORM=Win32 -DSPHINX_EXECUTABLE="$(pwd)/../sphinx-venv/Scripts/sphinx-build.exe"
106+
cmake .. -DCMAKE_TOOLCHAIN_FILE="%cd%\..\..\vcpkg\scripts\buildsystems\vcpkg.cmake"
96107
```
97108

109+
Open `ericw-tools.sln`.
110+
98111
#### IDE Tips - CLion
99112

100113
- Modify the "Google Test" run/debug configuration template to have `--gtest_catch_exceptions=0`, otherwise the

0 commit comments

Comments
 (0)