Commit eb01da541c09942e354fc3aeff0bb029662ad6c6

Thomas de Grivel 2024-09-08T17:09:04

document HTTPd

diff --git a/doc/HTTPd/index.en.md b/doc/HTTPd/index.en.md
new file mode 100644
index 0000000..7d5f6e5
--- /dev/null
+++ b/doc/HTTPd/index.en.md
@@ -0,0 +1,36 @@
+# 1 KC3 HTTPd web server
+
+The source files for the KC3 HTTPd web server are in `/httpd`.
+
+## 1.1 Dependencies
+
+The web server depends on :
+ - KC3
+   - libkc3
+   - event
+   - socket
+   - http
+ - [SASS](https://sass-lang.com/) for CSS rendering
+ - [ESBuild](https://esbuild.github.io/) for Javascript rendering
+
+## 1.2 Configuration
+
+The web server must be started in a directory containing the following
+files :
+
+```
+./app/controllers/     # controllers directory (.kc3)
+./app/templates/       # templates directory (.ekc3)
+./app/views/           # views directory (.kc3)
+./assets/              # assets directory
+./assets/css/          # css directory
+./assets/css/app.scss  # application css, compiled to ./static/_assets/app.css
+./assets/js/           # javascript directory
+./assets/js/app.js     # application javascript, compiled to ./static/_assets/app.js
+./assets/node_modules/ # from npm
+./config/routes.kc3    # dynamic routes
+./static/              # for static files
+./static/_assets/      # for static asset files
+./static/_fonts/       # for static font files
+./static/_images/      # for static image files
+```
diff --git a/doc/index.en.md b/doc/index.en.md
index c1f021d..8535447 100644
--- a/doc/index.en.md
+++ b/doc/index.en.md
@@ -4,4 +4,5 @@ The KC3 programming language documentation.
 
 
 ## Index
-- [KC3](KC3/)
+- [KC3](KC3/) core language.
+- [HTTPd](HTTPd/) web server.