aboutsummaryrefslogtreecommitdiff
path: root/examples/html/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'examples/html/README.md')
-rw-r--r--examples/html/README.md25
1 files changed, 25 insertions, 0 deletions
diff --git a/examples/html/README.md b/examples/html/README.md
new file mode 100644
index 0000000..ac89287
--- /dev/null
+++ b/examples/html/README.md
@@ -0,0 +1,25 @@
+# HTML serializer example
+
+This example shows a minimal application that serializes a HTML file
+and writes it to standard output.
+
+## 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. The following text
+should be written to the standard output:
+
+```
+<html>
+ <head>
+ <meta charset="UTF-8"/>
+ </head>
+ <body>testing slweb</body>
+</html>
+```