Technical guide

The Basics

• Developer’s Glossary Developer's GlossarySome terms that a developer may run across.

• Source Tree Basics Source TreeA picture of the most commonly encountered branches of the FreeCAD Source Tree.

• The Application Module Application ModuleOverview of application module structure.

• The Source Code in More Depth

• Writing Code for Translation Code for TranslationHow to write code with strings that should be translated.

• Automated Testing Automated TestingAutomated Testing.

• Dealing with Property Changes Property ChangesDealing with Property Changes. A brief introduction.

• The FreeCAD developer’s tool set:

  • C++ and Python
  • Qt: a cross platform development framework
  • OpenCascade: a geometry library
  • Coin3d: a scenegraph manager based on OpenInventor that handles drawing in the 3d window.
  • Pivy: a Python binding for Coin3d

• Reference Library Reference LibraryReference Library.

Modifying FreeCAD

• Contributing to FreeCAD

  • The process for submitting changes to FreeCAD is described in the CONTRIBUTING file in the root of the source tree.

• Creating a WorkBench

• The PowerUser’s hub in the FreeCAD wiki contains good information about Python scripting and workbench creation

• Python stubs package Python stubsPython stubs.

• Accessing User Preferences PreferencesHow to handle, retrieve and update user preferences.

• Controlling Object Deletion Object deletionHow to control object deletion.

• Create a Python Binding for C++ Class Python BindingCreate a Python Binding for C++.

• Checklist for Adding a Feature to a Workbench in C++ Feature checklistChecklist for adding a new feature to an existing workbench in C++.

Release Management

• Overview Release ProcessHigh-level overview of the release planning and management process.

  • Major Releases Major ReleasesGuide for Major Releases.
  • Minor Releases Minor ReleasesGuide for Minor Releases.
  • Building Release Packages Building release packagesHow to build FreeCAD packages for the different supported platforms.

See Also

• Wiki Developer Hub

• Compiling

• Useful Python Modules

• OpenCascade Tutorials

• OpenCascade overview presentation

• OpenCasacde online documentation

• Scripted Objects