Skip to content

开源白板工具(SaaS),一体化白板,包含思维导图、流程图、自由画等。All in one open-source whiteboard tool with mind, flowchart, freehand and etc.

build: add repo structure description (#35)

pubuzhixing827ae73a1b5eb
diff --git a/README.md b/README.md
index 9316f07..b7ba9f3 100644
--- a/README.md
+++ b/README.md
@@ -52,6 +52,26 @@
Drawnix 是插件架构,与前面说到开源工具比技术架构更复杂一些,但是插件架构也有优势,比如能够支持多种 UI 框架(*Angular、React*),能够集成不同富文本框架(当前仅支持 *Slate* 框架),在开发上可以很好的实现业务的分层,开发各种细粒度的可复用插件,可以扩展更多的画板的应用场景。
+
+## 仓储结构
+
+```
+drawnix/
+├── apps/
+│ ├── web # drawnix.com
+│ │ └── index.html # HTML
+├── dist/ # 构建产物
+├── packages/
+│ └── drawnix/ # 白板应用
+│ └── react-board/ # 白板 React 视图层
+│ └── react-text/ # 文本渲染模块
+├── package.json
+├── ...
+└── README.md
+└── README_en.md
+
+```
+
## 应用
[*https://drawnix.com*](https://drawnix.com) 是 *drawnix* 的最小化应用。
diff --git a/README_en.md b/README_en.md
index 6e7551b..0ffdfa9 100644
--- a/README_en.md
+++ b/README_en.md
@@ -51,6 +51,25 @@ Like a Phoenix, creativity must rise from the flames to be reborn, and ***Drawni
*Drawnix* uses a *plugin architecture*, which is technically more complex than the previously mentioned *open-source* tools. However, this *plugin architecture* has its advantages: it supports multiple *UI frameworks* (*Angular*, *React*), integrates with different *rich text frameworks* (currently only supporting *Slate* framework), enables better business layer separation in development, allows development of various fine-grained reusable plugins, and can expand to more whiteboard application scenarios.
+## Repository Structure
+
+```
+drawnix/
+├── apps/
+│ ├── web # drawnix.com
+│ │ └── index.html # HTML
+├── dist/ # Build artifacts
+├── packages/
+│ └── drawnix/ # Whiteboard application core
+│ └── react-board/ # Whiteboard react view layer
+│ └── react-text/ # Text rendering module
+├── package.json
+├── ...
+└── README.md
+└── README_en.md
+
+```
+
## Try It Out
*https://drawnix.com* is the minimal application of *drawnix*.