為了系統(tǒng)學習FreeCAD,并作出自己的貢獻,決定翻譯《FreeCAD Mod Dev Guide》。
本書原始地址:https://github.com/qingfengxia/FreeCAD_Mod_Dev_Guide
翻譯開始
FreeCAD模塊開發(fā)指南
作者?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)最新版本的發(fā)布而更新,尤其是在遷移到Python3 + Pyside2之后。我計劃于圣誕節(jié)前后為FreeCAD 0.19發(fā)布最新版。
本書許可證
類似FreeCAD文檔許可證為CC-BY 3.0
本書許可證為 署名-相同方式共享 4.0 國際共享許可證(Attribution-ShareAlike 4.0 International)
全文請參閱此庫中的文件以及在線版https://creativecommons.org/licenses/by-sa/4.0/。簡而言之,此許可證允許您:
共享- 通過任何媒介和任何形式復制、轉(zhuǎn)載本作品 。
改變- 在任意用途下合成、轉(zhuǎn)換和改造本作品,包括商業(yè)性的。
只要求您:共享您的衍生作品(相同方式共享)并歸功于作者(署名)。
致謝FreeCAD開發(fā)者
原始/主要開發(fā)者:
* Jürgen Riegel
* Werner Mayer
* yorik van havre
其他所有貢獻者,請參見https://www.freecadweb.org/wiki/Contributors
目標讀者:新模塊開發(fā)者
確保身為用戶的您熟悉FreeCAD工作臺圖形用戶界面(GUI)和應用程序接口(API):
* FreeCAD官方維基上的基礎文檔。
* FreeCAD python API 文檔
* 單個文件PDF用戶手冊,用于快速入門
Doxygen 文檔鏈接
Doxygen 生成的在線文檔源于0.16dev版,將很快刪除
Doxygen 于2019-06-24生成的在線文檔源于0.19dev版
我為什么要寫這本書
* 了解FreeCAD的軟件架構(gòu):一個大型開源項目
* 了解如何使用git為像FreeCAD這樣的開源項目做出貢獻
* 為新開發(fā)者探索FreeCAD源代碼節(jié)省時間
* 在為FreeCAD編寫/貢獻代碼時,記錄個人筆記和教訓
* 經(jīng)審查可用后,希望本書的某些章節(jié)能合并到官方維基中
我的研究:“自動化及智能工程設計”
如何為本書做貢獻
* 撰寫未完成的主題/章節(jié)(列在todo.md分支中),并請求`git clone https://github.com/qingfengxia/FreeCAD_Mod_Dev_Guide.git`。
* 為過時的代碼分析報告錯誤。由于本書在代碼分析時,F(xiàn)reeCAD正在進行深度開發(fā),因此引用的源代碼可能會很快過時。請在這個github問題板中指出我的報告錯誤之處。
* 本書使用python腳本進行預處理,請在腳本文件夾的Readme中查看詳情。有一些錨文本,例如:
*?[src/*.h/cpp]被處理為鏈接到最新的官方FreeCAD源。
* 其他一些錨文本"## folders ... ",將很快被更明確地標記出來。
向我的家人致謝
直到2019年時,此項工作尚未獲得我的雇主們(牛津大學,英國原子能局)的資助。這是一項社區(qū)志愿工作,感謝每一條評論,均為本書做出了貢獻。
Qingfeng Xia 感謝我的妻子J.Wang女士,以及其他家庭成員,讓我免除家務活來完成這項工作。
版權(quán)聲明:本文翻譯自《Module developer's guide to FreeCAD source code》,遵循 CC 4.0 BY-SA 協(xié)議(https://creativecommons.org/licenses/by-sa/4.0/),轉(zhuǎn)載請附上原文出處鏈接及本聲明。原文鏈接:https://github.com/qingfengxia/FreeCAD_Mod_Dev_Guide