From 3845fc36c034cee647d713209241ddeb6a267a22 Mon Sep 17 00:00:00 2001
From: nnbcccscdscdsc <2709767634@qq.com>
Date: Fri, 13 Mar 2026 06:49:21 +0000
Subject: [PATCH] =?UTF-8?q?Docs:=E6=9B=B4=E6=96=B0=E9=A1=B9=E7=9B=AE?=
 =?UTF-8?q?=E6=9E=B6=E6=9E=84?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 README.md | 21 +++++++++++++++++++++
 1 file changed, 21 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..7a8205d
--- /dev/null
+++ b/README.md
@@ -0,0 +1,21 @@
+OmniSocket/
+├── include/
+│   ├── common.h          # 全局定义：MsgHeader 结构体、错误码、宏定义
+│   ├── network.h         # 定义统一的协议接口 (omni_init, omni_send等)
+│   ├── kcp/              # 存放外部 KCP 源码 (ikcp.h, ikcp.c)
+│   └── logger.h          # 日志统计函数声明
+├── src/
+│   ├── protocols/
+│   │   ├── tcp_impl.c    # TCP 专用实现
+│   │   ├── udp_impl.c    # UDP 专用实现
+│   │   └── kcp_impl.c    # KCP 专用实现（调用 ikcp.c）
+│   ├── core/
+│   │   ├── network.c     # 协议分发逻辑（根据参数选 TCP/UDP/KCP）
+│   │   └── logger.c      # 延迟计算、吞吐量统计逻辑实现
+│   ├── apps/
+│   │   ├── client_main.c # 客户端入口（文件读取、指令接收）
+│   │   ├── server_main.c # 服务端入口（指令输入、数据接收）
+│   │   └── relay_main.c  # 转发器入口（中转逻辑）
+├── build/                # 编译产物目录
+├── Makefile              # 关键：支持 make server 和 make client_arm
+└── README.md             # 运行指南与参数说明
\ No newline at end of file