Skip to content

Commit 65ed5f5

Browse files
committed
chore: updated build instructions
1 parent 6b4246c commit 65ed5f5

1 file changed

Lines changed: 37 additions & 4 deletions

File tree

README.md

Lines changed: 37 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -49,11 +49,42 @@ cmake -B build -DCMAKE_PREFIX_PATH=/path/to/qt
4949
Then build:
5050

5151
```sh
52-
# Debug
53-
cmake --build build --config Debug
52+
# Linux: build type set at configure time, not build time
53+
cmake -B build -DCMAKE_BUILD_TYPE=Release
54+
cmake --build build --parallel
55+
56+
# Windows: build type set at build time via --config
57+
cmake --build build --config Release --parallel
58+
```
59+
60+
If needed, change the build type to `Debug`
61+
62+
## Running Tests
5463

55-
# Release
56-
cmake --build build --config Release
64+
Fetch the test suite and sample binaries alongside the other components:
65+
66+
```sh
67+
cmake -DREDASM_FETCH_TESTS=ON -P Setup.cmake
68+
```
69+
70+
Configure with the samples path and build:
71+
72+
```sh
73+
# Linux
74+
cmake -B build -DREDASM_SAMPLES=/path/to/workspace/samples
75+
76+
# Windows
77+
cmake -B build -DCMAKE_PREFIX_PATH=C:\Qt\6.8.3\msvc2022_64 -DREDASM_SAMPLES=C:\path\to\workspace\samples
78+
```
79+
80+
Run the tests:
81+
82+
```sh
83+
# Linux
84+
ctest --test-dir build --output-on-failure
85+
86+
# Windows
87+
ctest --test-dir build -C Release --output-on-failure
5788
```
5889

5990
## Pinning Versions (CI / Release)
@@ -138,3 +169,5 @@ Key fingerprints:
138169
| [commands](https://github.com/redasm-dev/commands) | Command plugins |
139170
| [analyzers](https://github.com/redasm-dev/analyzers) | Analyzer plugins |
140171
| [kb](https://github.com/redasm-dev/kb) | Knowledge Base |
172+
| [tests](https://github.com/redasm-dev/tests) | Test suite |
173+
| [samples](https://github.com/redasm-dev/samples) | Sample binaries |

0 commit comments

Comments
 (0)