Developer hub: Difference between revisions

From FreeCAD Documentation
No edit summary
No edit summary
 
(40 intermediate revisions by 13 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 11: Line 11:
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 [http://forum.freecadweb.org/index.php?sid=5f84150e79db8842e277b042077097ff forum] and someone will look into it (or, if you are feeling bold, why not edit this page directly!).
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 [http://forum.freecadweb.org/index.php?sid=5f84150e79db8842e277b042077097ff forum] and someone will look into it (or, if you are feeling bold, why not edit this page directly!).


== Developer Documentation == <!--T:32-->


== Developer Documentation == <!--T:4-->
<!--T:4-->
The developer documentation comprises the following sections:
The developer documentation comprises the following sections:


=== Do it yourself: Compiling FreeCAD === <!--T:5-->
=== Compiling FreeCAD === <!--T:33-->

* [[Source code management]]
<!--T:5-->
* [[Tracker|Find assistance]] when you have a problem or think you may have found a bug
* [https://github.com/FreeCAD/FreeCAD Github repo]. If you are new to git, read [[Source code management|Source code management]]
* [[CompileOnWindows|Compiling on Windows]]
* [[Compile_on_Docker|Compile with Docker]]
* [[CompileOnUnix|Compiling on Unix]]
* [[CompileOnMac|Compiling on Mac OS X]]
* [[Compile_on_Windows|Compiling on Windows]]
* [[Compile_on_Linux|Compiling on Linux]]
* [[Compile_on_MacOS|Compiling on MacOS]]
* [[Licence|Licence details]] about the FreeCAD licences
* [[Licence|Licence details]] about the FreeCAD licences
* [[Third Party Libraries]]
* [[Third Party Libraries|Third Party Libraries]]
* [[Third Party Tools]]
* [[Third Party Tools|Third Party Tools]]
* [[Start up and Configuration]]
* [[Start up and Configuration|Start up and Configuration]]
* [[Source documentation]]
* [[Source documentation|Source documentation]]
* Use the [[Tracker|bug tracker]] when you have a problem or think you may have found a bug


=== Packaging === <!--T:19-->
=== Packaging === <!--T:19-->

<!--T:26-->
[[Packaging|Packaging]] consists in taking the compiled binaries and Python source files of FreeCAD, and distributing them for use in a particular system.


<!--T:20-->
<!--T:20-->
* [[Linux_packaging|Linux packaging]]
* [[Debian_development|Debian development]]
* [[Debian_Unstable|Debian Unstable]]
** [[Debian_development|Debian development]]
** [[Debian_Unstable|Debian Unstable]]
* [[Git_buildpackage|Git buildpackage]]
** [[Git_buildpackage|Git buildpackage]]
* [[Windows_packaging|Windows packaging]]
* [[MacOS_packaging|MacOS packaging]]

=== Build Support Tools === <!--T:34-->

<!--T:6-->
* The [[FreeCAD Build Tool|FreeCAD Build Tool]]
** [[Workbench_creation|Adding an application module]] to FreeCAD
* [[Debugging|Debugging]] FreeCAD
* [[Testing|Testing]] FreeCAD
* [[Compiling (Speeding up)|Compiling (Speeding up)]] FreeCAD
* [[Continuous Integration|Continuous Integration]]


=== Build Support Tools === <!--T:6-->
=== Modifying FreeCAD === <!--T:35-->
* The [[FreeCAD Build Tool]]
** [[Module_Creation|Adding an application module]] to FreeCAD
* [[Debugging]] FreeCAD
* [[Testing]] FreeCAD
* [[Compiling (Speeding up)]] FreeCAD
* [[Continuous Integration]]


=== Modifying FreeCAD === <!--T:7-->
<!--T:7-->
* Understanding [[The FreeCAD source code]]
* Understanding [[The FreeCAD source code|The FreeCAD source code]]
* [[Tracker#Submitting_patches | Submitting patches]]
* [[Tracker#Submitting_patches|Submitting patches]]
* Add [[Gui Command|Features]] to FreeCAD or a Workbench
* Add [[Gui Command|Features]] to FreeCAD or a Workbench
* [[Branding]] or ''how to give FreeCAD a unique look''
* [[Branding|Branding]] or ''how to give FreeCAD a unique look''
* [[Artwork]] we made for FreeCAD, that you can freely reuse
* [[Artwork|Artwork]] we made for FreeCAD, that you can freely reuse
* [[Artwork_Guidelines|Artwork guidelines]] standards for icons
* [[Artwork_Guidelines|Artwork guidelines]] standards for icons
* [[Localisation|Translating FreeCAD]]
* [[Localisation|Translating FreeCAD]]
* [[Extra python modules]], or ''how to extend python functionality within FreeCAD''
* [[Extra python modules|Extra python modules]], or ''how to extend python functionality within FreeCAD''
* [[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]] 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-->
* [[Translating an external workbench]]
* [[Translating an external workbench|Translating an external workbench]]


=== Module developer's guide === <!--T:13-->
=== Module developer's guide === <!--T:36-->

<!--T:13-->
[https://github.com/qingfengxia/FreeCAD_Mod_Dev_Guide FreeCAD Mod Dev Guide]: This is an ebook under writing on github, please fork and send pull request to contribute.
[https://github.com/qingfengxia/FreeCAD_Mod_Dev_Guide FreeCAD Mod Dev Guide]: This is an ebook under writing on github, please fork and send pull request to contribute.


Line 88: Line 106:
* [https://dev.opencascade.org/doc/refman/html/index.html Reference Manual]
* [https://dev.opencascade.org/doc/refman/html/index.html Reference Manual]
* [http://opencascade.wikidot.com The openCascade wiki] (currently containing ?? Chinese spam)
* [http://opencascade.wikidot.com The openCascade wiki] (currently containing ?? Chinese spam)

==== File format ==== <!--T:27-->

<!--T:28-->
[[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 102: Line 125:
The development of a new solver architecture could improve the way the solver is used both in the [[Sketcher Workbench|Sketcher Workbench]], and for assembly of 3D bodies. See [https://forum.freecadweb.org/viewtopic.php?f=20&t=40525 Reimplementing constraint solver].
The development of a new solver architecture could improve the way the solver is used both in the [[Sketcher Workbench|Sketcher Workbench]], and for assembly of 3D bodies. See [https://forum.freecadweb.org/viewtopic.php?f=20&t=40525 Reimplementing constraint solver].


== Roadmap == <!--T:9-->
== Roadmap == <!--T:37-->

<!--T:9-->
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
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.
to reach a state where we can compete with commercial software.


<!--T:10-->
<!--T:39-->
* [[Development roadmap]]
[[FreeCAD_1.0_Development_Cycle|FreeCAD 1.0 Development Cycle]]


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

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

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


<!--T:12-->
<!--T:11-->
== Credits ==
[[Category:Hubs]]
[[Contributors|Contributors]]
[[Category:Developer Documentation]]


</translate>
</translate>
{{Userdocnavi{{#translation:}}}}
[[Category:Hubs{{#translation:}}]]
[[Category:Developer Documentation{{#translation:}}]]

Latest revision as of 20:58, 24 March 2023


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