diff --git a/README.md b/README.md index e69de29..2689b73 100644 --- a/README.md +++ b/README.md @@ -0,0 +1,45 @@ +# RobotFS 文档 + +RobotFS 是一个轻量级的文件系统服务,提供用于管理文件和目录的HTTP请求接口。它支持基本的文件操作,包括创建、上传、写入和删除文件及目录。 + +## 功能特性 + +- 文件系统基本操作(创建、下载、写入、删除) +- 目录管理 +- 文件管理 + +## 编译部署 + +### 环境要求 + +- Go 1.16 或更高版本 +- Protocol Buffers 编译器 (protoc) + +### 编译步骤 + +1. 生成 Protocol Buffers 文件 +```bash +make proto +``` + +2. 编译项目 +- 在当前平台编译: +```bash +make build +``` +- 编译 Linux 版本: +```bash +make build-linux +``` + +3. 清理编译文件 +```bash +make clean +``` + +### 运行服务 + +编译完成后,运行生成的二进制文件并指定配置文件: +```bash +./robotfs --config=/path/to/config.yml +``` \ No newline at end of file