diff options
Diffstat (limited to 'examples/hello/README.md')
| -rw-r--r-- | examples/hello/README.md | 17 |
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. |