From 86852cbbbed5035143b0f1a7c6e641a1ec1a8de9 Mon Sep 17 00:00:00 2001 From: manbo Date: Fri, 9 Jan 2026 15:59:03 +0800 Subject: [PATCH] Update README.md --- README.md | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 4afcf89..9478ef2 100644 --- a/README.md +++ b/README.md @@ -1 +1,10 @@ -## Hi there! \ No newline at end of file +## File organisation +Currently, there are 4 parts of docs: + +- **API**: contains detailed docs about API designs. (Note that `system_design.md` is a temp draft for discussing high-level design, not for API definitations). + +- **knowledges**: contains theorical knowledges/designs for the project (mainly diffusion stuffs). + +- **notes4coding**: contains deatiled description for coding, may be useful to coding agents (like codex). + +- **papers**: contains useful papers we've found in pdf.