thunderbrewhq/squall
1
0
Fork 0
mirror of https://github.com/thunderbrewhq/squall.git synced 2026-02-04 00:49:08 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

chore(style): clean up line endings in CONTRIBUTING.md

Browse source
This commit is contained in:
fallenoak 2025-11-20 21:36:52 -06:00
parent be1ab67257
commit d971058bc1
1 changed files with 34 additions and 34 deletions
Download patch file Download diff file Expand all files Collapse all files

68
CONTRIBUTING.md
View file

@ -1,34 +1,34 @@
## Running Tests ## Running Tests
### Coverage ### Coverage
Only runnable with GCC. Only runnable with GCC.
1. `sudo apt install lcov` 1. `sudo apt install lcov`
2. `mkdir build` 2. `mkdir build`
3. `cd build` 3. `cd build`
4. `cmake -DCMAKE_BUILD_TYPE=Debug ..` 4. `cmake -DCMAKE_BUILD_TYPE=Debug ..`
5. `make StormCoverage` 5. `make StormCoverage`
Open the resulting `html` file for the report. Open the resulting `html` file for the report.
### Against an original copy of Storm.dll ### Against an original copy of Storm.dll
Only runnable on Windows. Allows running tests against the original `storm.dll` rather than against the recreated code, to test accuracy. Only runnable on Windows. Allows running tests against the original `storm.dll` rather than against the recreated code, to test accuracy.
1. `mkdir build` 1. `mkdir build`
2. `cd build` 2. `cd build`
2. `cmake -DWHOA_TEST_STORMDLL=1 -DWHOA_STORM_FLAVOR=SC1 -A Win32 ..`. 2. `cmake -DWHOA_TEST_STORMDLL=1 -DWHOA_STORM_FLAVOR=SC1 -A Win32 ..`.
3. `cmake --build .` 3. `cmake --build .`
4. Copy `storm.dll` from your Starcraft 1.17 installation folder to the same directory as `StormTest.exe`. 4. Copy `storm.dll` from your Starcraft 1.17 installation folder to the same directory as `StormTest.exe`.
5. Run `StormTest.exe` from the command line. 5. Run `StormTest.exe` from the command line.
To use a different version of Storm.dll, use the following arguments in the cmake command: To use a different version of Storm.dll, use the following arguments in the cmake command:
| Arguments | Games | | Arguments | Games |
|-----------|-------| |-----------|-------|
|`-DWHOA_STORMDLL_VERSION=2016`| Starcraft 1.17 | |`-DWHOA_STORMDLL_VERSION=2016`| Starcraft 1.17 |
|`-DWHOA_STORMDLL_VERSION=2007`| Starcraft 1.15.0 ~ 1.16.1 | |`-DWHOA_STORMDLL_VERSION=2007`| Starcraft 1.15.0 ~ 1.16.1 |
|`-DWHOA_STORMDLL_VERSION=2004`| Starcraft 1.11b ~ 1.14 | |`-DWHOA_STORMDLL_VERSION=2004`| Starcraft 1.11b ~ 1.14 |
|`-DWHOA_STORMDLL_VERSION=2003`| Starcraft 1.10 ~ 1.11, Diablo II 1.10 ~ 1.13d | |`-DWHOA_STORMDLL_VERSION=2003`| Starcraft 1.10 ~ 1.11, Diablo II 1.10 ~ 1.13d |
|`-DWHOA_STORMDLL_VERSION=2000`| Diablo 1.09, Starcraft 1.08 ~ Starcraft 1.09b, Diablo II 1.06 ~ Diablo II 1.09d, Warcraft II: BNE 2.02.1 | |`-DWHOA_STORMDLL_VERSION=2000`| Diablo 1.09, Starcraft 1.08 ~ Starcraft 1.09b, Diablo II 1.06 ~ Diablo II 1.09d, Warcraft II: BNE 2.02.1 |
|`-DWHOA_STORMDLL_VERSION=1999`| Diablo 1.08, Diablo II 1.0 ~ Diablo II 1.05b | |`-DWHOA_STORMDLL_VERSION=1999`| Diablo 1.08, Diablo II 1.0 ~ Diablo II 1.05b |