aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorXavier Del Campo Romero <xavi.dcr@tutanota.com>2023-08-06 16:43:57 +0200
committerXavier Del Campo Romero <xavi.dcr@tutanota.com>2023-08-09 00:32:13 +0200
commit4ee88984fcca86c5b0c9c4bbb7e9148c7d2fe9db (patch)
treeaa4ab670afd116e419a9661bd266e7c3d0b56dc4 /README.md
parent83b8b8c2b3622ff7dfc46adf25b6723f1abfb0b5 (diff)
downloadlibweb-4ee88984fcca86c5b0c9c4bbb7e9148c7d2fe9db.tar.gz
Add hello world example
Diffstat (limited to 'README.md')
-rw-r--r--README.md19
1 files changed, 19 insertions, 0 deletions
diff --git a/README.md b/README.md
index ddc1a01..b800eba 100644
--- a/README.md
+++ b/README.md
@@ -103,6 +103,25 @@ add_subdirectory(slweb)
target_link_libraries(${PROJECT_NAME} PRIVATE slweb)
```
+### Examples
+
+[A directory](examples) with examples shows how `slweb` can be used by
+applications. These can be built from the top-level directory with:
+
+```sh
+$ make examples
+```
+
+In the case of CMake builds, examples are built by default. This can be turned
+off by assigning `BUILD_EXAMPLES` to `OFF` or `0`:
+
+```sh
+$ mkdir build/
+$ cd build/
+$ cmake .. -DBUILD_EXAMPLES=OFF
+$ cmake --build .
+```
+
## Why this project?
Originally, `slweb` was part of the