Add build macros section
10
Home.md
10
Home.md
@@ -25,9 +25,15 @@ For more info on the available variables and targets, run
|
|||||||
make help
|
make help
|
||||||
```
|
```
|
||||||
|
|
||||||
On Windows, you can run the `build.ps` script in PowerShell. This will also build the library using Microsoft's `msvc` compiler and run the tests. However, this PowerShell script isn't at feature parity yet with the available Makefile.
|
On Windows, you can run the `build.ps1` script in PowerShell. This will also build the library using Microsoft's `msvc` compiler and run the tests. However, this PowerShell script isn't at feature parity yet with the available `Makefile`.
|
||||||
|
|
||||||
While this might seem as a limitation, the library is basically structured so you don't even need any build system.
|
While this might seem as a limitation, the library is basically structured so you don't even need any build system. Both the `Makefile` and the `build.ps1` script are mostly meant to be used for development purposes rather than necessarily
|
||||||
|
|
||||||
|
### Build Macros
|
||||||
|
|
||||||
|
When using the library without the build scripts, there are a couple of macros that you might want to consider defining:
|
||||||
|
- `WAPP_DEBUG_ASSERT` -> Enables some extra checks for debug builds. It's highly encouraged to define this macro when developing with the library to catch any mistakes.
|
||||||
|
- `WAPP_NO_RUNTIME_ASSERT` -> Disables all runtime safety checks. Ideally, this macro should ***NEVER*** be used. However, if you are absolutely confident and would like to skip all safety checks at runtime, feel free to define it.
|
||||||
|
|
||||||
## Library Structure
|
## Library Structure
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user