翻译 GDB 官方文档
项目地址
https://github.com/shootercheng/gdb-translate.git
项目结构
bash
$ tree -L 1
.
├── cmd
├── go.mod
├── input
├── internal
├── LICENSE
├── output
├── README.md
├── sys_prompt.md
└── tests
- input 文件夹:输入的原始英文html,根据 gdb 源码生成的
- output 文件夹:存放调用大模型翻译后生成的中文 HTML 文件。这些文件是机器翻译的初稿,可能存在不准确或生硬之处,欢迎社区成员审阅、修正并提交合并请求(Pull Request)来共同完善。
项目简介
gdb-translate 是一个旨在将 GNU 调试器 (GDB) 官方文档(英文)实现自动化翻译的工具项目。GDB 是 Linux/Unix 系统下强大的源代码级调试器,但其官方手册内容庞大,对中文开发者存在一定的语言门槛。本项目通过结合大模型 API 与本地处理,尝试为中文社区提供一份可读性更强的 GDB 文档。
项目目标
- 自动化翻译:批量处理 GDB 官方 HTML 文档,调用大模型服务生成中文初稿。
- 保持结构:确保翻译后的文档保持原有的章节结构、代码示例和超链接。
- 社区共建:生成的翻译初稿作为基础,鼓励开发者根据专业知识进行校对、润色和术语统一,最终产出高质量的本地化文档。
如何参与贡献?
我们非常欢迎任何形式的贡献,让这份文档变得更好:
- 代码贡献 :如果您熟悉 Go 语言、HTML 解析或网络请求,可以查看项目的 Issues 列表,修复 Bug 或实现新功能。
- 文档校对 :这是最重要的环节!即使不懂编程,您也可以帮助我们。项目运行后会生成翻译后的
.html文件,您可以:- 通读翻译内容,修正明显的机器翻译错误。
- 统一专业术语(例如,将 "breakpoint" 统一译为"断点")。
- 优化句子,使其更符合中文技术文档的表达习惯。
- 反馈与建议:在使用翻译文档或本项目过程中遇到任何问题,或有好的想法,都欢迎在 GitHub 仓库提交 Issue 进行讨论。
贡献流程简述
- Fork 本仓库到您的 GitHub 账户。
- 克隆您的 Fork 到本地,创建新的分支进行修改。
- 完成修改后,提交代码并推送到您的仓库。
- 向本仓库发起 Pull Request (PR),并描述您的修改内容。
让我们共同努力,降低 GDB 的学习门槛,助力中文开发者社区!
官方文档地址
https://sourceware.org/gdb/documentation/
下载源码包
编译html
- 检查环境,解决依赖,生成Makefile
bash
$ ./configure
- 根据错误提示安装依赖
bash
$ sudo apt update
$ sudo apt install libgmp-dev libmpfr-dev texinfo
- 编译html
bash
$ make html
html 文档在 ${workdir}/gdb-17.2/gdb/doc/gdb 中生成
bash
~/gdb-17.2/gdb/doc/gdb$ ls -lt|grep ".html"|wc -l
866
一共有866个html文件
运行翻译程序
- 安装环境变量加载工具
bash
$ go install github.com/joho/godotenv/cmd/godotenv@latest
$ godotenv
Run a process with an env setup from a .env file
godotenv [-o] [-f ENV_FILE_PATHS] COMMAND_ARGS
ENV_FILE_PATHS: comma separated paths to .env files
COMMAND_ARGS: command and args you want to run
example
godotenv -f /path/to/something/.env,/another/path/.env fortune
- 运行测试
bash
$ godotenv -f .env go test ./tests/...
ok github.com/shootercheng/gdb-translate/tests/internal/request 26.403s
- 运行主程序
bash
$ godotenv -f .env go run ./cmd/main/main.go