Difference between revisions of "Developer hub/sv"

From FreeCAD Documentation
Jump to navigation Jump to search
(Updating to match new version of source page)
(Updating to match new version of source page)
 
(22 intermediate revisions by the same user not shown)
Line 1: Line 1:
 +
<languages/>
  
 
[[Image:Crystal_Clear_app_tutorials.png|right|150]]
 
[[Image:Crystal_Clear_app_tutorials.png|right|150]]
Line 6: Line 7:
 
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 ==
  
== Developer Documentation ==
 
 
The developer documentation comprises the following sections:
 
The developer documentation comprises the following sections:
  
=== Do it yourself: Compiling FreeCAD ===
+
=== Compiling FreeCAD ===
* [[Source code management]]
+
 
* [[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]]
+
* [[Compile_on_Windows|Compiling on Windows]]
* [[CompileOnMac|Compiling on Mac OS X]]
+
* [[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 ===
 +
 
 +
[[Packaging|Packaging]] consists in taking the compiled binaries and Python source files of FreeCAD, and distributing them for use in a particular system.
 +
 
 +
* [[Linux_packaging|Linux packaging]]
 +
** [[Debian_development|Debian development]]
 +
** [[Debian_Unstable|Debian Unstable]]
 +
** [[Git_buildpackage|Git buildpackage]]
 +
* [[Windows_packaging|Windows packaging]]
 +
* [[MacOS_packaging|MacOS packaging]]
  
 
=== Build Support Tools ===
 
=== Build Support Tools ===
* The [[FreeCAD Build Tool]]
+
 
** [[Module_Creation|Adding an application module]] to FreeCAD
+
* The [[FreeCAD Build Tool|FreeCAD Build Tool]]
* [[Debugging]] FreeCAD
+
** [[Workbench_creation|Adding an application module]] to FreeCAD
* [[Testing]] FreeCAD
+
* [[Debugging|Debugging]] FreeCAD
 +
* [[Testing|Testing]] FreeCAD
 +
* [[Compiling (Speeding up)|Compiling (Speeding up)]] FreeCAD
 +
* [[Continuous Integration|Continuous Integration]]
  
 
=== Modifying FreeCAD ===
 
=== Modifying FreeCAD ===
* Understanding [[The FreeCAD source code]]
+
 
 +
* Understanding [[The FreeCAD source code|The FreeCAD source code]]
 +
* [[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
 
* [[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|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
 +
 
 +
* [[Translating an external workbench|Translating an external workbench]]
  
 
=== Module developer's guide ===
 
=== Module developer's guide ===
This is an ebook under writing on github [https://github.com/qingfengxia/FreeCAD_Mod_Dev_Guide], please fork and send pull request to contribute.
 
  
chapters:
+
[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.
 +
 
 +
Chapters:
 
* Overview and Software Architecture
 
* Overview and Software Architecture
 
* Source code structure
 
* Source code structure
Line 52: Line 77:
 
* Contribute code with git
 
* Contribute code with git
  
Latest pdf preview can be downoaded from pdf folder of this git repo [https://github.com/qingfengxia/FreeCAD_Mod_Dev_Guide/tree/master/pdf]
+
Latest pdf preview can be downoaded from [https://github.com/qingfengxia/FreeCAD_Mod_Dev_Guide/tree/master/pdf 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.
  
=== OpenCascade Documentation ===
 
 
* [http://opencascade.wikidot.com/romansarticles Roman Lygin's tutorials]
 
* [http://opencascade.wikidot.com/romansarticles Roman Lygin's tutorials]
* [http://opencascade.sourcearchive.com/documentation/6.3.0.dfsg.1-1/classes.html Online class reference]. This is the help data on-line for the last version that they offer this way, it is out of date but still helpful and often still relevant. It is perhaps more convenient that having to download a single large file, which is what you have to do for a more recent version.
+
* [https://dev.opencascade.org/cdoc/overview/html/index.html Full Online Documentation]
* [http://opencascade.wikidot.com The openCascade wiki]
+
* [https://dev.opencascade.org/doc/refman/html/index.html Reference Manual]
 +
* [http://opencascade.wikidot.com The openCascade wiki] (currently containing ?? Chinese spam)
 +
 
 +
==== File format ====
 +
 
 +
[[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 ====
 +
 
 +
* [https://forum.freecadweb.org/viewtopic.php?f=10&t=36355 Sketcher Solver Architecture Booklet] (forum thread), [https://github.com/abdullahtahiriyo/FreeCADBooks/tree/master/FreeCAD_Solver_Architecture source] in GitHub.
 +
* [https://github.com/FreeCAD/FreeCAD/blob/master/src/Mod/Sketcher/App/planegcs/ PlaneGCS solver] in the FreeCAD source code; important files are [https://github.com/FreeCAD/FreeCAD/blob/master/src/Mod/Sketcher/App/planegcs/GCS.cpp GCS.cpp] and [https://github.com/FreeCAD/FreeCAD/blob/master/src/Mod/Sketcher/App/planegcs/SubSystem.cpp SubSystem.cpp].
 +
* [https://forum.freecadweb.org/viewtopic.php?f=9&t=29192 Recent Several Sketcher improvements].
 +
 
 +
The sketcher solver isn't perfect, as there are some issues with numerical precision when using large values, see [https://forum.freecadweb.org/viewtopic.php?f=10&t=40502 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|Sketcher Workbench]], and for assembly of 3D bodies. See [https://forum.freecadweb.org/viewtopic.php?f=20&t=40525 Reimplementing constraint solver].
  
 
== Roadmap ==
 
== 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  
 
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.
 +
 
 +
[[0.20_Development_Cycle|0.20 Development Cycle]]
  
* [[Development roadmap]]
+
== Community ==
  
== Credits ==
+
* [irc://chat.freenode.net/freecad IRC channel] ,synchronized with [https://gitter.im/FreeCAD/FreeCAD gitter channel]
[[Contributors]]
+
* [https://forum.freecadweb.org/viewforum.php?f=6 Development forum]
  
[[Category:Hubs/sv]] [[Category:Developer Documentation/sv]]
+
* [[Development roadmap|Development roadmap]]
  
 +
== Credits ==
 +
[[Contributors|Contributors]]
  
<languages/>
+
{{Userdocnavi{{#translation:}}}}
 +
[[Category:Hubs{{#translation:}}]]
 +
[[Category:Developer Documentation{{#translation:}}]]

Latest revision as of 11:00, 14 August 2021

Other languages:
Deutsch • ‎English • ‎español • ‎français • ‎hrvatski • ‎italiano • ‎polski • ‎português • ‎português do Brasil • ‎română • ‎svenska • ‎čeština • ‎русский • ‎中文(中国大陆)‎ • ‎한국어
150

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.

0.20 Development Cycle

Community

Credits

Contributors