Added description to cmake variable.

This commit is contained in:
Arron David Nelson 2024-02-01 01:34:38 -08:00
parent bae5dae6ca
commit 225c06aff2

View File

@ -14,6 +14,8 @@
1. `cmake -DCMAKE_BUILD_TYPE=Release -DLINUX_WINDOW_SYSTEM:STRING=XCB /path/to/source` 1. `cmake -DCMAKE_BUILD_TYPE=Release -DLINUX_WINDOW_SYSTEM:STRING=XCB /path/to/source`
2. `cmake --build /path/to/build --config Release` 2. `cmake --build /path/to/build --config Release`
The `LINUX_WINDOW_SYSTEM` variable in the first step can be either `XCB` for the X Window System or `Wayland` for the Wayland Window System. Wayland support is currently not fully supported yet, use only `XCB`.
# Simple Example # Simple Example
```cpp ```cpp
#include <ehs/EHS.h> #include <ehs/EHS.h>
@ -37,7 +39,7 @@ void LogRaised(const ehs::Log& log)
ehs::Console::Write_8(result); ehs::Console::Write_8(result);
} }
ehs::SInt_32 Main(ehs::Str_8* appName, ehs::Str_8* appVerId, ehs::Version* appVer) ehs::Int_32 Main(ehs::Str_8* appName, ehs::Str_8* appVerId, ehs::Version* appVer)
{ {
// Simple identifying meta-data for the logger. // Simple identifying meta-data for the logger.
*appName = "Simple Example App"; // The application's name *appName = "Simple Example App"; // The application's name