mirrors/zap
1
0
Fork 0
mirror of https://github.com/zigzap/zap.git synced 2025-10-21 07:34:08 +00:00
Code Activity

update README: docs

Browse source
This commit is contained in:
Rene Schallner 2024-01-10 15:50:47 +01:00
parent f4563f2357
commit 23b70b8881
1 changed files with 17 additions and 15 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
README.md
View file

@ -28,6 +28,9 @@ Exactly the goals I set out to achieve!
## Most FAQ:
- Q: **Where is the API documentation?**
- A: Docs are a work in progress. You can check them out [here](https://zigzap.org/zap). The docs are based on the `zig-0.12.0` branch but apply to the current release (zig 0.11.0), too.
- A: Run `zig build run-docserver` to serve them locally.
- Q: **Zap doesn't build with Zig master?**
- A: See the 0.12.0 branch. An example of how to use it is
[here](https://github.com/zigzap/hello-0.12.0). Please note that the 0.12.0
@ -39,13 +42,12 @@ Exactly the goals I set out to achieve!
on Windows are WSL2 or a docker container.
- Q: **Does ZAP support TLS / HTTPS?**
- A: Yes, ZAP supports using the system's openssl. See the
[https](./examples/https/https.zig) example and make sure to build with
the `-Dopenssl` flag or the environment variable `ZAP_USE_OPENSSL=true`:
- `.openssl = true,` (in dependent projects' build.zig, `b.dependency("zap" .{...})`)
[https](./examples/https/https.zig) example and make sure to build with the
`-Dopenssl` flag or the environment variable `ZAP_USE_OPENSSL=true`:
- `.openssl = true,` (in dependent projects' build.zig, `b.dependency("zap"
.{...})`)
- `ZAP_USE_OPENSSL=true zig build https`
- `zig build -Dopenssl=true https`
- Q: **Are there API docs?**
- A: They are under development. Git clone this, then run `zig build run-docserver`.
## Here's what works