add docs
This commit is contained in:
@@ -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
|
||||
|
||||
Reference in New Issue
Block a user