add docs

2024-11-10 18:56:52 +01:00
parent 454daa148e
commit 3cc1613d93
6 changed files with 2879 additions and 1 deletions
@@ -1,5 +1,6 @@
 build/
 .cache/
+docs/

 # Prerequisites
 *.d
@@ -0,0 +1,3 @@
+[submodule "doxygen-awesome-css"]
+	path = doxygen-awesome-css
+	url = https://github.com/jothepro/doxygen-awesome-css.git
@@ -3,6 +3,8 @@ A simple Web Server written in C (learning purposes), it works only on Linux sys

 ## Requirements
 - [meson](https://mesonbuild.com/index.html)
+- [doxygen](https://www.doxygen.nl/)
+  - Optional, just to build the docs

 ## How to build
 ```bash
@@ -12,6 +14,13 @@ $ meson compile
 ```
 And then run `cws`!

+## Docs
+```bash
+$ git submodule update --init # inside the cws directory
+$ doxygen
+```
+And then open the `docs/html/index.html`.
+
 ## Roadmap
 - [x] Understading basic web server concepts
 - [ ] Basic server
@@ -1,4 +1,4 @@
-project('cws', 'c')
+project('cws', 'c', version: '1.0.0')

 subdir('src')
 incdir = include_directories('include')