84 lines (54 loc) · 2.16 KB

WriteDebugString - Installation and Use

Requisites
Building
- via CMake

Requisites

The WriteDebugString program (implemented in main.c) is implemented in terms of:

STLSoft - for WinSTL diagnostics helpers and platform utilities;

Detailed instructions are provided in the REQUISITES.md document for how to obtain and install STLSoft.

NOTE: WriteDebugString targets Windows only.

Building

via CMake

The primary choice for installation is by use of CMake.

Obtain the latest distribution of WriteDebugString, from https://github.com/sistools/WriteDebugString/, e.g.
```
$ mkdir -p ~/open-source
$ cd ~/open-source
$ git clone https://github.com/sistools/WriteDebugString/
```
Prepare the CMake configuration, via the prepare_cmake.sh script, as in:
```
$ cd ~/open-source/WriteDebugString
$ ./prepare_cmake.sh
```
NOTE: if you do not have STLSoft installed via CMake package config, point at a local tree with -s / --stlsoft-root-dir, or set the STLSOFT environment variable.

Tests are currently a no-op for this project; you may disable the testing option with -T if desired:
```
$ cd ~/open-source/WriteDebugString
$ ./prepare_cmake.sh -T
```
Run a build of the generated CMake-derived build files via the build_cmake.sh script, as in:
```
$ cd ~/open-source/WriteDebugString
$ ./build_cmake.sh
```
(NOTE: if you provide the flag --run-make (=== -m) in step 2 then you do not need this step.)
As a check, execute the built program, as in:
```
$ cd ~/open-source/WriteDebugString
$ ./_build/writedebugstring.exe --help
```
You should see usage output naming writedebugstring.

Install (optional), as in:

$ cd ~/open-source/WriteDebugString
$ cmake --install ./_build --config Release