aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
author魏曹先生 <1992414357@qq.com>2026-08-08 16:16:41 +0800
committer魏曹先生 <1992414357@qq.com>2026-08-08 16:16:41 +0800
commitd8219ce7e1eab552483056d7058270f166a4d6a7 (patch)
treefe90a5c0ebc82007d59ed079bd7d2266e52716eb
parent24f9ab53d0130f0643fc122a2a8905540530194a (diff)
docs: add architecture overview to README
-rw-r--r--README.md7
1 files changed, 7 insertions, 0 deletions
diff --git a/README.md b/README.md
index 93657c2..c8518ef 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,8 @@
# Cigarette Hacker
+
+> [!WARNING]
+> This project is in an early exploratory stage with many experimental features, so the documentation focuses on technical description rather than game content description.
+
+## Architecture
+
+Godot `*.tscn` files are used to describe scenes, and the `tools/tscn-to-bsn` tool is used to map them to bevy scenes `*.bsn` for use.