aboutsummaryrefslogtreecommitdiff
path: root/examples/hello/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 /examples/hello/README.md
parent83b8b8c2b3622ff7dfc46adf25b6723f1abfb0b5 (diff)
downloadlibweb-4ee88984fcca86c5b0c9c4bbb7e9148c7d2fe9db.tar.gz
Add hello world example
Diffstat (limited to 'examples/hello/README.md')
-rw-r--r--examples/hello/README.md17
1 files changed, 17 insertions, 0 deletions
diff --git a/examples/hello/README.md b/examples/hello/README.md
new file mode 100644
index 0000000..7c7cf74
--- /dev/null
+++ b/examples/hello/README.md
@@ -0,0 +1,17 @@
+# "Hello world" example
+
+This example shows a minimal setup for an application using `slweb`. When
+executed, it starts a HTTP/1.1 server on port `8080` and returns an example
+website reading "Hello from slweb!" when either `/` or `/index.html` are
+accessed by clients.
+
+## How to build
+
+If using `make(1)`, just run `make` from this directory.
+
+If using CMake, examples are built by default when configuring the project
+from [the top-level `CMakeLists.txt`](../../CMakeLists.txt).
+
+## How to run
+
+Run the executable without any command line arguments.