FreeCAD Build Tool: Difference between revisions
(Initial description) |
(Module_Creation -> Workbench_creation) |
||
(31 intermediate revisions by 13 users not shown) | |||
Line 1: | Line 1: | ||
<languages/> |
|||
<translate> |
|||
<!--T:15--> |
|||
{{Docnav |
|||
|[[Testing|Testing]] |
|||
|[[Continuous_Integration|Continuous Integration]] |
|||
}} |
|||
</translate> |
|||
{{TOCright}} |
|||
<translate> |
|||
==Overview== <!--T:1--> |
|||
The '''FreeCAD build tool''' or '''fcbt''' is a python script located at |
The '''FreeCAD build tool''' or '''fcbt''' is a python script located at |
||
</translate> |
|||
⚫ | |||
{{Code|code= |
|||
⚫ | |||
}} |
|||
<translate> |
|||
<!--T:2--> |
|||
It can be used to simplify some frequent tasks in building, distributing and extending FreeCAD. |
It can be used to simplify some frequent tasks in building, distributing and extending FreeCAD. |
||
== Usage == |
== Usage == <!--T:3--> |
||
With [[Python]] correctly installed, fcbt can be invoked by the command |
With [[wikipedia:Python (programming language)|Python]] correctly installed, ''fcbt'' can be invoked by the command |
||
</translate> |
|||
⚫ | |||
{{Code|code= |
|||
⚫ | |||
}} |
|||
<translate> |
|||
<!--T:4--> |
|||
It displays a menu, where you can select the task you want to use it for: |
It displays a menu, where you can select the task you want to use it for: |
||
</translate> |
|||
⚫ | |||
{{Code|code= |
|||
⚫ | |||
⚫ | |||
⚫ | |||
⚫ | |||
⚫ | |||
⚫ | |||
⚫ | |||
⚫ | |||
- DistBin (DB) Build a binary Distr. of the current source tree |
|||
- DistSrc (DS) Build a source Distr. of the current source tree |
|||
- DistBin (DB) Build a binary Distr. of the current source tree |
|||
- DistSetup (DI) Build a Setup Distr. of the current source tree |
|||
- DistSetup (DUI) Build a User Setup Distr. of the current source tree |
|||
- DistAll (DA) Run all three above modules |
|||
- NextBuildNumber (NBN) Increase the Build Number of this Version |
|||
- CreateModule (CM) Insert a new FreeCAD Module (Workbench) in the module directory |
|||
For help on the modules type: |
|||
fcbt <command name> ? |
|||
}} |
|||
⚫ | |||
<translate> |
|||
<!--T:5--> |
|||
⚫ | |||
=== DistSrc === <!--T:6--> |
|||
⚫ | |||
=== |
=== DistBin === <!--T:7--> |
||
The command " |
The command "DB" '''creates a binary distribution''' of the current source tree. |
||
=== |
=== DistSetup === <!--T:8--> |
||
The command " |
The command "DI" '''creates a setup distribution''' of the current source tree. |
||
=== DistSetup === |
=== DistSetup === <!--T:9--> |
||
The command " |
The command "DUI" '''creates a user setup distribution''' of the current source tree. |
||
=== |
=== DistAll === <!--T:10--> |
||
The command " |
The command "DA" executes "DS", "DB" and "DI" in sequence. |
||
=== |
=== NextBuildNumber === <!--T:11--> |
||
⚫ | |||
The command "DA" executes "DS", "DB" and "DI" in sequence- |
|||
=== |
=== CreateModule === <!--T:12--> |
||
⚫ | |||
The command "BD" creates the software documentation running [[DoxyGen]] that must be installed. |
|||
=== NextBuildNumber === |
|||
⚫ | |||
<!--T:13--> |
|||
=== CreateModule === |
|||
{{Docnav |
|||
⚫ | |||
|[[Testing|Testing]] |
|||
|[[Continuous_Integration|Continuous Integration]] |
|||
}} |
|||
</translate> |
|||
⚫ | |||
{{Userdocnavi{{#translation:}}}} |
|||
⚫ | |||
{{clear}} |
Latest revision as of 13:08, 13 August 2021
Overview
The FreeCAD build tool or fcbt is a python script located at
trunc/src/Tools/fcbt.py
It can be used to simplify some frequent tasks in building, distributing and extending FreeCAD.
Usage
With Python correctly installed, fcbt can be invoked by the command
python fbct.py
It displays a menu, where you can select the task you want to use it for:
FreeCAD Build Tool
Usage:
fcbt <command name> [command parameter]
possible commands are:
- DistSrc (DS) Build a source Distr. of the current source tree
- DistBin (DB) Build a binary Distr. of the current source tree
- DistSetup (DI) Build a Setup Distr. of the current source tree
- DistSetup (DUI) Build a User Setup Distr. of the current source tree
- DistAll (DA) Run all three above modules
- NextBuildNumber (NBN) Increase the Build Number of this Version
- CreateModule (CM) Insert a new FreeCAD Module (Workbench) in the module directory
For help on the modules type:
fcbt <command name> ?
At the input prompt enter the abbreviated command you want to call. For example type "CM" for creating a module.
DistSrc
The command "DS" creates a source distribution of the current source tree.
DistBin
The command "DB" creates a binary distribution of the current source tree.
DistSetup
The command "DI" creates a setup distribution of the current source tree.
DistSetup
The command "DUI" creates a user setup distribution of the current source tree.
DistAll
The command "DA" executes "DS", "DB" and "DI" in sequence.
NextBuildNumber
The "NBN" command increments the build number to create a new release version of FreeCAD.
CreateModule
The "CM" command creates a new application module (Workbench).
- Getting started
- Installation: Download, Windows, Linux, Mac, Additional components, Docker, AppImage, Ubuntu Snap
- Basics: About FreeCAD, Interface, Mouse navigation, Selection methods, Object name, Preferences, Workbenches, Document structure, Properties, Help FreeCAD, Donate
- Help: Tutorials, Video tutorials
- Workbenches: Std Base, Arch, Assembly, CAM, Draft, FEM, Inspection, Mesh, OpenSCAD, Part, PartDesign, Points, Reverse Engineering, Robot, Sketcher, Spreadsheet, Start, Surface, TechDraw, Test Framework, Web
- Hubs: User hub, Power users hub, Developer hub