Early preview of ebook: Module developer' guide to FreeCAD source

Info about new community or project announcements, implemented features, classes, modules or APIs. Might get technical!
PLEASE DO NOT POST HELP REQUESTS OR OTHER DISCUSSIONS HERE!
Forum rules
Be nice to others! Respect the FreeCAD code of conduct!
Post Reply
qingfeng.xia
Posts: 227
Joined: Tue Sep 22, 2015 1:47 pm
Location: Oxford UK/Shenzhen China
Contact:

Early preview of ebook: Module developer' guide to FreeCAD source

Post by qingfeng.xia »

link to download the early preview
https://www.iesensor.com/download/FreeC ... 160920.pdf
This is pandoc generated from my markdown notes, during developing CFD module.

it will be uploaded to github soon after a check soon (Oct 2016)
https://github.com/qingfengxia/FreeCAD_ ... _Guide.git

for discussion
============
This is an early preview, in some of the chapter only the outline/code is provided without any explanation.
Please ignore the format errors, since I have not checked the image pos, paragraph spaces, code wrapping error.

- Please provide some structural advice on this book to make it useful for new developer, like some more chapter is needed.
- Some of my thoughts might be false, please point out:
- some features like how TaskPanel works, is not clear to me, so it is not discussed.
- some topic like how the document is serialized into FCStd file and reload, may be not stop module developer to make new module, is not explored.
- Is that possible to develop PreferencePage in python?
- Is there a better way to reference to doxygen graph with URL, I am not sure the URL is fixed for diff version.

my todo list:
===========
1. There are huge quantity of GUI widgets, needs not be explored. However, the widget for quantity value input should be exampled like, adding SpnBox to QDevelop and taskPanel

2. Translation and i18n process is not exampled, since i have not reached such step for CFD module.

3. how to use ccache to reduce compilation time

Thanks
Ubuntu 18.04 LTS 64bit, python3, always work with latest FreeCAD daily build
Working on Cfd module for FreeCAD, FreeCAD_Module_Develop_Guide
https://github.com/ukaea/parallel-preprocessor/
https://github.com/qingfengxia/Cfd
User avatar
yorik
Founder
Posts: 13640
Joined: Tue Feb 17, 2009 9:16 pm
Location: Brussels
Contact:

Re: Early preview of ebook: Module developer' guide to FreeCAD source

Post by yorik »

Wow, this is AMAZING!!! :o
Thank you so much for writing this.. With that, I don't think many other open-source projects will have better code documentation than FreeCAD!
User avatar
Gift
Posts: 769
Joined: Tue Aug 18, 2015 10:08 am
Location: Germany, Sauerland

Re: Early preview of ebook: Module developer' guide to FreeCAD source

Post by Gift »

1.3.3 GPL code will not be included into installler
thx for the bedtime story. :D
User avatar
wandererfan
Veteran
Posts: 6268
Joined: Tue Nov 06, 2012 5:42 pm
Contact:

Re: Early preview of ebook: Module developer' guide to FreeCAD source

Post by wandererfan »

Thank you for this! A FreeCAD programmer's manual has been on my todo list for at least a year. Glad to see one come to life.

wf
User avatar
bernd
Veteran
Posts: 12849
Joined: Sun Sep 08, 2013 8:07 pm
Location: Zürich, Switzerland
Contact:

Re: Early preview of ebook: Module developer' guide to FreeCAD source

Post by bernd »

How about updates for this amazing book qingfeng?
Post Reply