From 4ee88984fcca86c5b0c9c4bbb7e9148c7d2fe9db Mon Sep 17 00:00:00 2001
From: Xavier Del Campo Romero <xavi.dcr@tutanota.com>
Date: Sun, 6 Aug 2023 16:43:57 +0200
Subject: Add hello world example

---
 README.md | 19 +++++++++++++++++++
 1 file changed, 19 insertions(+)

(limited to 'README.md')

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
-- 
cgit v1.2.3