Skip to content

Commit a6f6cff

Browse files
committed
Update readme
1 parent 2edd0e7 commit a6f6cff

1 file changed

Lines changed: 3 additions & 33 deletions

File tree

README.md

Lines changed: 3 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -138,8 +138,9 @@ The source should compile on Windows using MSVC, macOS using clang, and Linux us
138138
There are a couple of project-specific CMake options to pass in that can change how the program is built.
139139
| Option | Default | Description |
140140
| --- | --- | --- |
141-
| WOWPKG_ENABLE_SANITIZERS | OFF | Builds the program with or without sanitizers |
142-
| WOWPKG_ENABLE_TESTS | OFF | Determines whether or not tests will be built |
141+
| WOWPKG_ENABLE_SANITIZERS | OFF | Builds the program with or without sanitizers. |
142+
| WOWPKG_ENABLE_TESTS | OFF | Determines whether or not tests will be built. |
143+
| WOWPKG_ENABLE_TESTS_INTEGRATION | OFF | Determines whether or not integration tests will be built. |
143144
| WOWPKG_USE_DEVELOPMENT_PATHS | OFF | When enabled, the path to config.ini and location are saved. wowpkg will be set to the [data](data) project directory. When disabled, the paths to config.ini are saved. wowpkg will be dependent on the current OS. %APPDATA%/wowpkg for Windows and ~/.config/wowpkg for macOS/Linux. Generally, use development paths unless the project is being built for packaging or release. |
144145

145146
1. Clone the repo.
@@ -165,34 +166,3 @@ There are a couple of project-specific CMake options to pass in that can change
165166
```
166167
6. Change the path in [config.ini](data/config.ini) to where you want the addons to be extracted. Something like `/path/to/wowpkg/data/addons`.
167168
7. Run the compiled program.
168-
169-
8. Clone the repo.
170-
9. Change to the project directory and get submodules.
171-
```
172-
$ cd wowpkg
173-
$ git submodule update --init
174-
```
175-
10. Run vcpkg bootstrap with `./vcpkg/bootstrap-vcpkg.sh` or `./vcpkg/bootstrap-vcpkg.bat` depending on your system.
176-
11. Install dependencies with vcpkg.
177-
178-
Windows
179-
180-
```
181-
$ ./vcpkg/vcpkg.exe install cjson:x64-windows curl:x64-windows minizip:x64-windows
182-
```
183-
184-
macOS/Linux
185-
186-
```
187-
$ ./vcpkg/vcpkg install cjson curl minizip
188-
```
189-
190-
12. Create a build directory and compile.
191-
```
192-
$ mkdir build
193-
$ cd build
194-
$ cmake .. -DWOWPKG_USE_DEVELOPMENT_PATHS:option=on
195-
$ cmake --build .
196-
```
197-
13. Change the path in [config.ini](data/config.ini) to where you want the addons to be extracted. Something like `/path/to/wowpkg/data/addons`.
198-
14. Run the compiled program.

0 commit comments

Comments
 (0)