From ca1a4a31706d0c03673fe4c414c645ed826b21c6 Mon Sep 17 00:00:00 2001
From: shu <nvcsadjkojf@outlook.com>
Date: Wed, 19 Aug 2026 15:56:06 +0800
Subject: 精简 Wiki 构建与运行方式
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

将浏览器端工具整理为 utilities 插件，移除 Docker、Org GTD 和 files API，并补充单文件构建及 Node.js 运行入口。
---
 README.md | 49 +++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 49 insertions(+)
 create mode 100644 README.md

(limited to 'README.md')

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..8555974
--- /dev/null
+++ b/README.md
@@ -0,0 +1,49 @@
+# tdwiki
+
+这个仓库支持两种本地使用方式：生成单文件 Wiki，或通过 Node.js 运行目录版 Wiki。
+
+## 环境
+
+需要 Node.js，以及与项目一致的 TiddlyWiki 5.4.1：
+
+```sh
+npm install --global tiddlywiki@5.4.1
+```
+
+确认安装：
+
+```sh
+tiddlywiki --version
+```
+
+## 生成单文件
+
+```sh
+./scripts/build.sh
+```
+
+输出文件为 `dist/tdwiki.html`。构建在临时 Wiki 中完成，不会改写源码目录下的条目。
+
+`tiddlywiki.info` 中也保留了对应的 `singlefile` 构建目标；日常构建建议使用上述脚本，以自动排除仅服务端使用的官方插件并检查输出内容。
+
+单文件包含浏览器端的本地 utilities 插件。
+
+如需指定其他 TiddlyWiki 可执行文件：
+
+```sh
+TIDDLYWIKI_BIN=/path/to/tiddlywiki ./scripts/build.sh
+```
+
+## 使用 Node.js 运行
+
+```sh
+./scripts/run.sh
+```
+
+默认地址为 `http://127.0.0.1:10000`。可以通过环境变量修改监听地址和端口：
+
+```sh
+TDWIKI_LISTEN_HOST=0.0.0.0 TDWIKI_LISTEN_PORT=8080 ./scripts/run.sh
+```
+
+目录版会加载 filesystem、tiddlyweb 和本地 utilities 插件，并直接使用仓库中的 `tiddlers/`、`plugins/` 与 `files/`。
-- 
cgit v1.2.3