Developer hub: Difference between revisions

From FreeCAD Documentation
(Marked this version for translation)
(Licence->License)
 
(24 intermediate revisions by 8 users not shown)
Line 1: Line 1:
<languages/>
<languages/>
{{TOCright}}
⚫
[[Image:Crystal_Clear_app_tutorials.png|64px]]
----
<translate>
<translate>

<!--T:1-->
⚫
[[Image:Crystal_Clear_app_tutorials.png|right|150]]


<!--T:2-->
<!--T:2-->
Line 24: Line 24:
* [[Compile_on_Linux|Compiling on Linux]]
* [[Compile_on_Linux|Compiling on Linux]]
* [[Compile_on_MacOS|Compiling on MacOS]]
* [[Compile_on_MacOS|Compiling on MacOS]]
* [[Licence|Licence details]] about the FreeCAD licences
* [[License|License details]] about the FreeCAD licences
* [[Third Party Libraries|Third Party Libraries]]
* [[Third Party Libraries|Third Party Libraries]]
* [[Third Party Tools|Third Party Tools]]
* [[Third Party Tools|Third Party Tools]]
Line 48: Line 48:
<!--T:6-->
<!--T:6-->
* The [[FreeCAD Build Tool|FreeCAD Build Tool]]
* The [[FreeCAD Build Tool|FreeCAD Build Tool]]
** [[Module_Creation|Adding an application module]] to FreeCAD
** [[Workbench_creation|Adding an application module]] to FreeCAD
* [[Debugging|Debugging]] FreeCAD
* [[Debugging|Debugging]] FreeCAD
* [[Testing|Testing]] FreeCAD
* [[Testing|Testing]] FreeCAD
Line 67: Line 67:
* [[Google Summer of Code|Google Summer of Code]] get involved via Google's student support program
* [[Google Summer of Code|Google Summer of Code]] get involved via Google's student support program
* [[Fine-tuning|Fine-tuning]] shows different options and parameter switches that can overcome problems
* [[Fine-tuning|Fine-tuning]] shows different options and parameter switches that can overcome problems
* [[Wrapping_a_Cplusplus_class_in_Python|Wrapping a C++ class in Python]] shows how to create the Python wrapper for a C++ class
* [[NewFeatureCheckList_C++|Checklist for adding a Feature to a C++ workbench]] provides an aid for contributors.


<!--T:16-->
<!--T:16-->
Line 108: Line 110:


<!--T:28-->
<!--T:28-->
[[File_Format_FCStd|File Format FCStd]]. The files created with FreeCAD are {{incode|.zip}} files that include the BREP geometry, as well as XML data that describes the document.
[[File_Format_FCStd|File Format FCStd]]. The files created with FreeCAD are {{incode|.zip}} files that include the [https://en.wikipedia.org/wiki/Boundary_representation BREP] geometry, as well as XML data that describes the document.


==== Sketcher solver ==== <!--T:22-->
==== Sketcher solver ==== <!--T:22-->
Line 129: Line 131:
to reach a state where we can compete with commercial software.
to reach a state where we can compete with commercial software.


<!--T:38-->
<!--T:39-->
[[0.20_Development_Cycle|0.20 Development Cycle]]
[[FreeCAD_1.0_Development_Cycle|FreeCAD 1.0 Development Cycle]]


== Community == <!--T:30-->
== Community == <!--T:30-->


<!--T:31-->
<!--T:31-->
* [irc://chat.freenode.net/freecad IRC channel] ,synchronized with [https://gitter.im/FreeCAD/FreeCAD gitter channel]
* [ircs://irc.libera.chat:6697/freecad IRC channel] ,synchronized with [https://gitter.im/FreeCAD/FreeCAD gitter channel]
* [https://forum.freecadweb.org/viewforum.php?f=6 Development forum]
* [https://forum.freecad.org/viewforum.php?f=6 Development forum]


<!--T:10-->
<!--T:10-->
* [[Development roadmap|Development roadmap]]
* [[Development roadmap|Development roadmap]]


== Credits == <!--T:11-->
<!--T:11-->
== Credits ==
[[Contributors|Contributors]]
[[Contributors|Contributors]]


Latest revision as of 16:24, 4 April 2024

Other languages:

This is the place to come if you want to contribute to the development of the FreeCAD software.

These pages are in the early stage of development. If you can't find the information you are looking for, or have found useful information somewhere we have not linked to, then please leave a comment on the forum and someone will look into it (or, if you are feeling bold, why not edit this page directly!).

Developer Documentation

The developer documentation comprises the following sections:

Compiling FreeCAD

Packaging

Packaging consists in taking the compiled binaries and Python source files of FreeCAD, and distributing them for use in a particular system.

Build Support Tools

Modifying FreeCAD

Module developer's guide

FreeCAD Mod Dev Guide: This is an ebook under writing on github, please fork and send pull request to contribute.

Chapters:

  • Overview and Software Architecture
  • Source code structure
  • Base and App module
  • Gui module
  • Python wrapping
  • Modular design
  • Fem module source analysis (mixed C++ and Python)
  • Development of CFD Module (pure Python)
  • Module testing and debugging
  • Contribute code with git

Latest pdf preview can be downoaded from pdf folder of this git repo

Internals

OpenCascade Documentation

OpenCascade is a software development platform for 3D surface and solid modeling, CAD data exchange, and visualization, mostly in the form of C++ libraries.

File format

File Format FCStd. The files created with FreeCAD are .zip files that include the BREP geometry, as well as XML data that describes the document.

Sketcher solver

The sketcher solver isn't perfect, as there are some issues with numerical precision when using large values, see Adventure of fixing sketcher solver for large sketches.

The development of a new solver architecture could improve the way the solver is used both in the Sketcher Workbench, and for assembly of 3D bodies. See Reimplementing constraint solver.

Roadmap

FreeCAD, though usable in certain areas, is at the beginning of a long way into the CAD mainstream. There is still a lot to do to reach a state where we can compete with commercial software.

FreeCAD 1.0 Development Cycle

Community

Credits

Contributors

User documentation
Retrieved from "http://wiki.freecad.org/index.php?title=Developer_hub&oldid=1392683"