From 13ae582a5d89805aae32cff25e500a43a8a0bfe3 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=E6=97=B6=E5=90=AF=E9=BE=99?= <shiqilong@beyondcent.com>
Date: Mon, 2 Dec 2024 15:18:53 +0800
Subject: [PATCH] docs: update README with project structure, dependencies,
 image handling, and node version requirements

---
 README.md | 32 ++++++++++++++++++++++++++++++++
 1 file changed, 32 insertions(+)

diff --git a/README.md b/README.md
index ab6199e..b819d8f 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,35 @@
+## 项目结构
+
+- main-web 主应用
+  - 提供登录页面/子应用入口
+- cmc-web 管理端
+  - webs 子应用
+  - packages 本地包
+  - dll 动态链接库, 没用到
+
+## 依赖项
+
+- @cmp/cmp-api: cmc-web/packages/api 本地代码
+- @cmp/cmp-common: cmc-web/packages/common 本地代码
+- @cmp/\*\*\*: npm 包
+
+## 项目中图片
+
+- 指向服务器 nginx: /web-common-resource
+
+## vite 启动/打包项目有问题的话就不用
+
+## 产物处理
+
+本地 main-web/cmc-web ----------------------> 服务器 /opt/cmp/consoles/cmc-web **不要覆盖,因为里面还有其他文件**
+本地 main-web/cmc-web/cof-web --------------> 服务器 /opt/cmp/consoles/cof-web
+
+本地 cmc-web/webs/xxx-web/xxx-web ----------> 服务器 /opt/cmp/consoles/cmc-web/sub-app/xxx-web
+
+# node 版本
+
+node 16.x 其他版本依赖可能会有问题
+
 # 下载依赖
 
 pnpm install