FreeCAD模块开发指南 前言

为了系统学习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

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 159,290评论 4 363
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 67,399评论 1 294
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 109,021评论 0 243
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 44,034评论 0 207
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,412评论 3 287
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,651评论 1 219
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,902评论 2 313
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,605评论 0 199
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,339评论 1 246
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,586评论 2 246
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 32,076评论 1 261
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,400评论 2 253
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 33,060评论 3 236
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,083评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,851评论 0 195
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,685评论 2 274
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,595评论 2 270

推荐阅读更多精彩内容