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!
qingfeng.xia
Posts: 153
Joined: Tue Sep 22, 2015 1:47 pm
Location: Oxford Uk
Contact:

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

Postby qingfeng.xia » Fri Sep 23, 2016 10:05 am

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 LTS 64bit in virtualbox, always work with latest FreeCAD git version
Mainly work on OpenFOAM + Fenics for CFD, FSI
User avatar
yorik
Site Admin
Posts: 11263
Joined: Tue Feb 17, 2009 9:16 pm
Location: São Paulo, Brazil
Contact:

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

Postby yorik » Fri Sep 23, 2016 4:00 pm

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: 418
Joined: Tue Aug 18, 2015 10:08 am
Location: Germany, Sauerland

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

Postby Gift » Fri Sep 23, 2016 8:34 pm

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

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

Postby wandererfan » Sat Sep 24, 2016 12:51 pm

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
Posts: 7903
Joined: Sun Sep 08, 2013 8:07 pm
Location: Zürich, Switzerland

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

Postby bernd » Fri Mar 29, 2019 10:07 am

How about updates for this amazing book qingfeng?