From 7fff13e48cbe2ecba922a20c849d061473d21843 Mon Sep 17 00:00:00 2001
From: zhilv <zhilv666@qq.com>
Date: Thu, 4 Dec 2025 00:22:54 +0800
Subject: [PATCH] =?UTF-8?q?docs:=20=E6=B7=BB=E5=8A=A0=E4=B8=AD=E6=96=87=20?=
 =?UTF-8?q?README=EF=BC=8C=E5=8C=85=E6=8B=AC=E5=8A=9F=E8=83=BD=E3=80=81?=
 =?UTF-8?q?=E4=BD=BF=E7=94=A8=E6=96=B9=E6=B3=95=E5=92=8C=E6=9E=84=E5=BB=BA?=
 =?UTF-8?q?=E4=BF=A1=E6=81=AF?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..57716be
--- /dev/null
+++ b/README.md
@@ -0,0 +1,41 @@
+# netctl
+
+`netctl` 是一个 Windows 下的网络管理 CLI 工具。  
+支持设置静态 IP、切换 DHCP，并管理教室配置文件。
+
+## 功能特点
+
+- 为网卡设置静态 IP
+- 切换网卡为 DHCP 自动获取 IP
+- 从 `yaml`、`toml` 或 `json` 加载教室配置
+- 导出默认教室配置（支持 `yaml`、`toml`、`json`）
+- 自动检测管理员权限并尝试自提升
+- 支持通过 `make` 构建，可选 UPX 压缩和 Zig 外链优化
+
+## 安装方法
+
+# 从源码编译
+make build
+编译完成后可执行文件输出到 ./bin/netctl.exe。
+
+### 使用方法
+```bash
+# 查看帮助
+netctl --help
+
+# 设置静态 IP
+netctl static
+
+# 切换网卡为 DHCP
+netctl dhcp
+
+# 导出默认配置
+netctl export --file ./config.yaml --format yaml
+```
+
+### 配置文件
+- 默认配置文件路径：./config.yaml（若不存在则使用内置默认配置）
+- 支持文件格式：yaml、yml、toml、json
+
+### 编译信息
+版本号、Git 提交 ID 和编译时间会在编译时通过 make 自动嵌入可执行文件。