Project homepage Mailing List  Warmcat.com  API Docs  Github Mirror 
    npro  
 Modern all-safe Rust Network Protocol library supporting h1, h2, h3, ws, wt sans-IO and with socket IO + tls
git clone https://npro.rs/repo/npro
 
root / src / jig / j-server.c
Author[]Andy Green <andy@warmcat.com> 2025-08-27 04:01 UTC
Committer[]Andy Green <andy@warmcat.com> 2025-08-27 06:27 UTC
Treead867dd05c5082c06412ca405b785cf52c24a651   Raw Patch
 
agents.md
agents.md
diff --git a/AGENTS.md b/AGENTS.md new file mode 100644 index 0000000..2251e1a --- /dev/null +++ b/AGENTS.md @@ -0,0 +1,35 @@ +# Sai AGENTS.md + +## Overview + +Please make high quality, not lazy implementation decisions. + +Our work should follow the existing usage of apis in the project as much as possible. + +## Coding + +We avoid things like `scanf` for carefully parsing with code, eg with `lws_tokenize` or similar. + +We avoid `FILE *` and use apis like open(), read(). + +We avoid casual linked-lists and use `lws_dll2_t`. + +We consider using lwsac instead of discrete allocations, if the pattern of allocations will benefit from it. + +## Build testing + +Please don't worry about build-testing, just push patches when you are confident they are complete and have considered all affected code (ie, not half-assed) and ready and I will try them and report back with grounded information. + +If you really want to build-test: + +Sai dependencies: + + - libwebsockets from main branch + - libssl-dev + - libsqlite3 + - Build lws: git init && git fetch https://github.com/warmcat/libwebsockets +main:main && cd libwebsockets && mkdir -p build && cd build && cmake .. -DLWS_UNIX_SOCK=1 -DLWS_WITH_STRUCT_JSON=1 -DLWS_WITH_JOSE=1 -DLWS_WITH_STRUCT_SQLITE3=1 -DLWS_WITH_GENCRYPTO=1 -DLWS_WITH_SPAWN=1 -DLWS_WITH_SECURE_STREAMS=1 && make && sudo make install && sudo ldconfig + + - sai (main branch shown) + - Build sai: git init && git fetch https://github.com/warmcat/sai +main:m && cd libwebsockets && mkdir -p build && cd build && cmake .. && make && sudo make install && sudo ldconfig + +
Page fetched 0s ago, creation time: 6ms (vhost etag hits: 0%, cache hits: 0%)