Module developer's guide to FreeCAD source code
by Qingfeng Xia http://www.iesensor.com
- 2015-09-18 version 0.1 for FreeCAD version 0.16-dev
- 2016-09-18 version 0.2 for FreeCAD version 0.17-dev
This ebook is licensed the same as FreeCAD document license CC-BY 3.0 http://creativecommons.org/licenses/by/3.0/
Original/lead developers:
Add all contributors see http://www.freecadweb.org/wiki/index.php?title=Contributors
Make sure you are familiar with FreeCAD workbench GUI and API as a user:
- Foundamental document on official wiki for FreeCAD
- FreeCAD python API document
- single file PDF user manual for quick start
Doxygen generated online documentation of source for 0.16dev
- Learn the software architecture of FreeCAD: a large open source project
- Learn to use git to contribute to open source projects like FreeCAD
- Save time for new developers to explore the source codde of FreeCAD
- Record personal note and lesson during writing/contributing code to FreeCAD
- Some chapters of this ebook is seeking to be merged into official wiki after reviewed as usable
- Chapters are written in markdown and PDF is generated by
pandoc
- Python scripts to link Introduction to header files:
*_folder_desc.py
- Python script
merge.py
merges chapters into single md file then PDF
- write on unfinished topics/chapters listed in todo.md
fork and pull request
git clone https://github.com/qingfengxia/FreeCAD_Mod_Dev_Guide.git
- file bug for outdated code analysis As this book is about code anlysis while FreeCAD is under heavy development, source codes quoted may outdated quickly. Please point out by report bugs in github
Thanks for my wife Ms J. Wang, and other family members' consideration