为了系统学习FreeCAD,并作出自己的贡献，决定翻译《FreeCAD Mod Dev Guide》。

本书原始地址：https://github.com/qingfengxia/FreeCAD_Mod_Dev_Guide

翻译开始

---

FreeCAD模块开发指南

作者 Qingfeng Xia 2016

作者 Luzpaz 2019

可从pdf文件夹下载最新版本

修订日志

- 2015-0918 0.1版 用于FreeCAD 0.16-dev版

- 2016-09-18 0.2版 用于FreeCAD 0.17-dev版

- 2019-06-18 再版目标 0.3版 用于FreeCAD 0.19-dev版

计划与进度

本书随(FreeCAD)最新版本的发布而更新，尤其是在迁移到Python3 + Pyside2之后。我计划于圣诞节前后为FreeCAD 0.19发布最新版。

本书许可证

类似FreeCAD文档许可证为CC-BY 3.0

本书许可证为 署名-相同方式共享 4.0 国际共享许可证（Attribution-ShareAlike 4.0 International）

全文请参阅此库中的文件以及在线版https://creativecommons.org/licenses/by-sa/4.0/。简而言之，此许可证允许您：

共享- 通过任何媒介和任何形式复制、转载本作品 。

改变- 在任意用途下合成、转换和改造本作品，包括商业性的。

只要求您：共享您的衍生作品（相同方式共享）并归功于作者（署名）。

致谢FreeCAD开发者

原始/主要开发者：

* Jürgen Riegel

* Werner Mayer

* yorik van havre

其他所有贡献者，请参见https://www.freecadweb.org/wiki/Contributors

目标读者：新模块开发者

确保身为用户的您熟悉FreeCAD工作台图形用户界面（GUI）和应用程序接口（API）：

* FreeCAD官方维基上的基础文档。

* FreeCAD python API 文档

* 单个文件PDF用户手册，用于快速入门

Doxygen 文档链接

Doxygen 生成的在线文档源于0.16dev版，将很快删除

Doxygen 于2019-06-24生成的在线文档源于0.19dev版

我为什么要写这本书

* 了解FreeCAD的软件架构：一个大型开源项目

* 了解如何使用git为像FreeCAD这样的开源项目做出贡献

* 为新开发者探索FreeCAD源代码节省时间

* 在为FreeCAD编写/贡献代码时,记录个人笔记和教训

* 经审查可用后，希望本书的某些章节能合并到官方维基中

我的研究：“自动化及智能工程设计”

如何为本书做贡献

* 撰写未完成的主题/章节（列在todo.md分支中），并请求`git clone https://github.com/qingfengxia/FreeCAD_Mod_Dev_Guide.git`。

* 为过时的代码分析报告错误。由于本书在代码分析时，FreeCAD正在进行深度开发，因此引用的源代码可能会很快过时。请在这个github问题板中指出我的报告错误之处。

* 本书使用python脚本进行预处理，请在脚本文件夹的Readme中查看详情。有一些锚文本，例如：

* [src/*.h/cpp]被处理为链接到最新的官方FreeCAD源。

* 其他一些锚文本"## folders ... "，将很快被更明确地标记出来。

向我的家人致谢

直到2019年时，此项工作尚未获得我的雇主们（牛津大学，英国原子能局）的资助。这是一项社区志愿工作，感谢每一条评论，均为本书做出了贡献。

Qingfeng Xia 感谢我的妻子J.Wang女士，以及其他家庭成员，让我免除家务活来完成这项工作。

---

版权声明：本文翻译自《Module developer's guide to FreeCAD source code》，遵循 CC 4.0 BY-SA 协议（https://creativecommons.org/licenses/by-sa/4.0/），转载请附上原文出处链接及本声明。原文链接：https://github.com/qingfengxia/FreeCAD_Mod_Dev_Guide