mirrors/zap
1
0
Fork 0
mirror of https://github.com/zigzap/zap.git synced 2025-10-20 23:24:09 +00:00
Code Activity

Cleanup FAQ of README.md

Browse source 
Deduplicate references to building with master, and remove outdated reference to future release of 0.13
This commit is contained in:
Matt Iversen 2024-09-30 01:51:28 +10:00 • committed by GitHub
parent 29b923f96e
commit 2bc3b7df89
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 15 additions and 17 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

34
README.md
View file

@ -24,30 +24,28 @@ proved to be:
Exactly the goals I set out to achieve! Exactly the goals I set out to achieve!
## Most FAQ: ## FAQ:
### Zap uses the latest stable zig release (0.13.0) for a reason. So you don't - Q: **What version of Zig does Zap support?**
have to keep up with frequent breaking changes. It's an "LTS feature". If you - Zap uses the latest stable zig release (0.13.0), so you don't have to keep
want to use zig master, use the `zig-master` branch but be aware that I don't up with frequent breaking changes. It's an "LTS feature".
provide `build.zig.zon` snippets or tagged releases for it for the time being. - Q: **Can Zap build with Zig's master branch?**
If you know what you are doing, that shouldn't stop you from using it with zig - See the `zig-master` branch. An example of how to use it is
master though.
- Q: **Where is the API documentation?**
- A: Docs are a work in progress. You can check them out
[here](https://zigzap.org/zap).
- A: Run `zig build run-docserver` to serve them locally.
- Q: **Zap doesn't build with Zig master?**
- A: See the zig-master branch. An example of how to use it is
[here](https://github.com/zigzap/hello-master). Please note that the [here](https://github.com/zigzap/hello-master). Please note that the
zig-master branch is not the official master branch of ZAP. Yet. Until zig zig-master branch is not the official master branch of ZAP. Be aware that
0.13.0 is released. I don't provide `build.zig.zon` snippets or tagged releases for it for
the time being. If you know what you are doing, that shouldn't stop you
from using it with zig master though.
- Q: **Where is the API documentation?**
- Docs are a work in progress. You can check them out
[here](https://zigzap.org/zap).
- Run `zig build run-docserver` to serve them locally.
- Q: **Does ZAP work on Windows?** - Q: **Does ZAP work on Windows?**
- A: No. This is due to the underlying facil.io C library. Future versions - No. This is due to the underlying facil.io C library. Future versions
of facil.io might support Windows but there is no timeline yet. Your best of facil.io might support Windows but there is no timeline yet. Your best
options on Windows are WSL2 or a docker container. options on Windows are WSL2 or a docker container.
- Q: **Does ZAP support TLS / HTTPS?** - Q: **Does ZAP support TLS / HTTPS?**
- A: Yes, ZAP supports using the system's openssl. See the - Yes, ZAP supports using the system's openssl. See the
[https](./examples/https/https.zig) example and make sure to build with [https](./examples/https/https.zig) example and make sure to build with
the `-Dopenssl` flag or the environment variable `ZAP_USE_OPENSSL=true`: the `-Dopenssl` flag or the environment variable `ZAP_USE_OPENSSL=true`:
- `.openssl = true,` (in dependent projects' build.zig, - `.openssl = true,` (in dependent projects' build.zig,