BYOT

主题

# Documentation

Complete documentation for build-your-own-tools

English | 简体中文

# Welcome

Welcome to the build-your-own-tools documentation. This documentation provides comprehensive guides, API references, and tutorials to help you understand, build, and contribute to the project.

# Documentation Structure

Following GitHub Community Best Practices:

docs/
├── README.md                 # This file - Documentation index
├── README.zh-CN.md           # 中文文档索引
├── setup/                    # Environment setup guides
│   ├── GETTING-STARTED.md    # Quick start guide (EN)
│   └── GETTING-STARTED.zh-CN.md  # 快速开始（中文）
├── tutorials/                # User tutorials and comparisons
│   ├── COMPARISON.md         # Rust vs Go comparison (EN)
│   └── COMPARISON.zh-CN.md   # Rust vs Go 对比（中文）
├── architecture/             # High-level architecture specs
│   ├── ARCHITECTURE.md       # System architecture (中文)
│   ├── ARCHITECTURE.zh-CN.md # 系统架构（中文）
│   ├── API.md                # API reference (中文)
│   └── API.zh-CN.md          # API 参考（中文）
├── assets/                   # Images, UML diagrams, static resources
└── changelogs/               # Changelog resources
    ├── INDEX.md              # All changelogs index
    ├── INDEX.zh-CN.md        # 变更日志索引
    └── MIGRATION.md          # Version migration guide

# Getting Started

New to build-your-own-tools? Start here:

  1. Getting Started - Set up your environment and build your first tool
  2. Architecture - Understand the system design and project structure
  3. Comparison - Learn the differences between Rust and Go implementations

# API Reference

Looking for function documentation? Check the API reference:

  • API Reference - Complete API documentation for all library modules

# Changelogs

Track project changes and migrations:

# Language Selection / 语言选择

Choose your preferred language:

# Sub-Projects

ProjectPathDescription
dos2unixdos2unix/CRLF to LF converter
gzipgzip/go/, gzip/rust/File compression tool
htophtop/System monitor TUI

# External Resources

# Contributing to Documentation

We welcome documentation improvements! Please see CONTRIBUTING.md for guidelines on:

  • Reporting documentation issues
  • Suggesting improvements
  • Submitting documentation PRs
  • Translation contributions

Last Updated: 2026-04-17
Documentation Version: 2.1