BYOT

主题

# 文档

build-your-own-tools 的完整文档

English | 简体中文

# 欢迎

欢迎阅读 build-your-own-tools 文档。本文档提供了全面的指南、API参考和教程，帮助你理解、构建和贡献本项目。

# 文档结构

遵循 GitHub 社区最佳实践：

docs/
├── README.md                 # 本文档 - 文档索引
├── README.zh-CN.md           # 本文档（中文）
├── setup/                    # 环境搭建指南
│   ├── GETTING-STARTED.md    # 快速开始指南（英文）
│   └── GETTING-STARTED.zh-CN.md  # 快速开始（中文）
├── tutorials/                # 用户教程和对比
│   ├── COMPARISON.md         # Rust vs Go 对比（英文）
│   └── COMPARISON.zh-CN.md   # Rust vs Go 对比（中文）
├── architecture/             # 高层架构规范
│   ├── ARCHITECTURE.md       # 系统架构（英文）
│   ├── ARCHITECTURE.zh-CN.md # 系统架构（中文）
│   ├── API.md                # API 参考（英文）
│   └── API.zh-CN.md          # API 参考（中文）
├── assets/                   # 图片、UML 图、静态资源
└── changelogs/               # 变更日志资源
    ├── INDEX.md              # 所有变更日志索引
    ├── INDEX.zh-CN.md        # 变更日志索引（中文）
    └── MIGRATION.md          # 版本迁移指南

# 快速开始

初次接触 build-your-own-tools？从这里开始：

  1. 快速开始 - 设置环境并构建你的第一个工具
  2. 架构指南 - 理解系统设计和项目结构
  3. 语言对比 - 了解 Rust 和 Go 实现的区别

# API 参考

查找函数文档？查看 API 参考：

# 变更日志

跟踪项目变化和迁移：

# 语言选择 / Language Selection

选择你的首选语言：

# 快速链接

# 项目链接

# 子项目

项目路径说明
dos2unixdos2unix/CRLF 转 LF 转换器
gzipgzip/go/, gzip/rust/文件压缩工具
htophtop/系统监控 TUI

# 外部资源

# 贡献文档

我们欢迎文档改进！请参阅 CONTRIBUTING.md 了解：

  • 报告文档问题
  • 建议改进
  • 提交文档 PR
  • 翻译贡献

术语中英文对照表

英文中文
Architecture架构
Comparison对比/比较
Documentation文档
Guide指南
Index索引
Migration迁移
Quick Start快速开始
Reference参考

最后更新: 2026-04-17
文档版本: 2.1