FreeCAD Build Tool: Difference between revisions

From FreeCAD Documentation
(translate)
(Module_Creation -> Workbench_creation)
 
(13 intermediate revisions by 4 users not shown)
Line 1: Line 1:
<languages/>
<translate>
<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>
</translate>
{{Code|code=
<syntaxhighlight>
trunc/src/Tools/fcbt.py
trunc/src/Tools/fcbt.py
}}
</syntaxhighlight>
<translate>
<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 [[wikipedia:Python (programming language)|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>
</translate>
{{Code|code=
<syntaxhighlight>
python fbct.py
python fbct.py
}}
</syntaxhighlight>
<translate>
<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>
</translate>
{{Code|code=
<syntaxhighlight>
FreeCAD Build Tool
FreeCAD Build Tool
Usage:
Usage:
fcbt <command name> [command parameter]
fcbt <command name> [command parameter]
possible commands are:
possible commands are:
- DistSrc (DS) Build a source 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
- DistBin (DB) Build a binary Distr. of the current source tree
- DistSetup (DI) Build a Setup 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
- DistSetup (DUI) Build a User Setup Distr. of the current source tree
- DistAll (DA) Run all three above modules
- DistAll (DA) Run all three above modules
- NextBuildNumber (NBN) Increase the Build Number of this Version
- NextBuildNumber (NBN) Increase the Build Number of this Version
- CreateModule (CM) Insert a new FreeCAD Module in the module directory
- CreateModule (CM) Insert a new FreeCAD Module (Workbench) in the module directory
For help on the modules type:
For help on the modules type:
fcbt <command name> ?
fcbt <command name> ?
}}
</syntaxhighlight>
<translate>
<translate>
<!--T:5-->
At the input promt enter the abbreviated command you want to call. For example type "CM" for [[Module Creation|creating a module]].
At the input prompt enter the abbreviated command you want to call. For example type "CM" for [[Workbench_creation|creating a module]].


=== DistSrc ===
=== DistSrc === <!--T:6-->
The command "DS" [[Create Source Distribution|creates a source distribution]] of the current source tree.
The command "DS" '''creates a source distribution''' of the current source tree.


=== DistBin ===
=== DistBin === <!--T:7-->
The command "DB" [[Create Binary Distibution|creates a binary distribution]] of the current source tree.
The command "DB" '''creates a binary distribution''' of the current source tree.


=== DistSetup ===
=== DistSetup === <!--T:8-->
The command "DI" [[Create Setup Distribution|creates a setup distribution]] of the current source tree.
The command "DI" '''creates a setup distribution''' of the current source tree.


=== DistSetup ===
=== DistSetup === <!--T:9-->
The command "DUI" [[Create User Setup Distribution|creates a user setup distribution]] of the current source tree.
The command "DUI" '''creates a user setup distribution''' of the current source tree.


=== DistAll ===
=== DistAll === <!--T:10-->
The command "DA" executes "DS", "DB" and "DI" in sequence.
The command "DA" executes "DS", "DB" and "DI" in sequence.


=== NextBuildNumber ===
=== NextBuildNumber === <!--T:11-->
The "NBN" command [[Increment Build Number|increments the build number]] to create a new release version of FreeCAD.
The "NBN" command '''increments the build number''' to create a new release version of FreeCAD.


=== CreateModule ===
=== CreateModule === <!--T:12-->
The "CM" command [[Module Creation|creates a new application module]].
The "CM" command [[Workbench_creation|creates a new application module (Workbench)]].


{{Docnav|Start up and Configuration|Module Creation}}


<!--T:13-->
[[Category:Developer Documentation]]
{{Docnav
|[[Testing|Testing]]
|[[Continuous_Integration|Continuous Integration]]
}}


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

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).