diff --git a/wiki/About_FreeCAD.wikitext b/wiki/About_FreeCAD.wikitext index 5f989239e2d..58f2422967a 100644 --- a/wiki/About_FreeCAD.wikitext +++ b/wiki/About_FreeCAD.wikitext @@ -1,65 +1,37 @@ -// ========================================================== -// 水烟碗 3D 实体模型数模工程代码 (Kaloud尺寸 + 粗砂陶工艺补偿版) -// 修正说明：优化了内部气道贯通性、螺旋线截断、标识贴合度 -// ========================================================== - -$fn = 100; // 提高3D曲面渲染精细度 -shrinkage_compensation = 1.11; // 11% 粗砂陶高温烧结收缩补偿系数 - -scale([shrinkage_compensation, shrinkage_compensation, shrinkage_compensation]) { - difference() { - // 【1. 外轮廓实体构建】 - union() { - // 下半部分：光面微锥形把柄 (高度59mm，底44mm，顶45mm) - cylinder(h=59, r1=22, r2=22.5); - - // 把柄与碗体衔接的顺滑圆角过渡区 - translate([0, 0, 54]) - cylinder(h=10, r1=22.5, r2=32); - - // 上半部分：碗体基础外轮廓 (高度37mm，总高101mm) - translate([0, 0, 64]) - cylinder(h=37, r1=32, r2=45.5); - - // 外部螺旋线条（增加外轮廓交集保护，防止螺旋线刺破烟仓内壁） - intersection() { - translate([0, 0, 64]) cylinder(h=37, r1=32, r2=45.5); - translate([0, 0, 64]) - for (a = [0 : 30 : 360]) { - rotate([0, 0, a]) - translate([29, 0, 0]) // 微调外移，保证凸起质感 - linear_extrude(height = 36, twist = -60, scale = 1.3) - circle(r = 3.5, $fn = 6); - } - } - } - - // 【2. 内部烟仓与气流通道掏空 (保证壁厚不低于 5mm)】 - // 顶部烟草仓：深21mm，完美适配 Kaloud 碳盒路径 - translate([0, 0, 80]) - cylinder(h=22, r1=28, r2=38); - - // 中央漏斗孔 (Funnel Spire)：上下完全贯通主气道 - // 原高度50~85mm有断层，现修正为45~82mm，与底部孔和烟仓完美交汇 - translate([0, 0, 45]) - cylinder(h=37, r1=5, r2=6); - - // 底部连接孔：带 1.5° 拔模斜度，深度扩展到 55mm 确保与中心气道重叠贯通 - translate([0, 0, -1]) - cylinder(h=56, r1=12.5, r2=11); - - // 【3. 品牌标识圆圈 U 凹刻加工 (深度 0.5mm)】 - // 原 Y=-45 悬空无法切削，现修正为 Y=-40 并增加 14° 倾角贴合碗体斜面 - translate([0, -40, 82]) - rotate([104, 0, 0]) { // 90度 + 14度外壁倾斜角 - // 外圈圆形边框 - difference() { - cylinder(h=2, r=9, center=true); - cylinder(h=3, r=7.5, center=true); - } - // 内圈大写字母 "U" - linear_extrude(height=2, center=true) - text("U", size=9, font="Liberation Serif:style=Bold", halign="center", valign="center"); - } - } -} \ No newline at end of file +FreeCAD is a free and open-source [[parametric_modeling|parametric]] 3D [[CAD|computer-aided design]] (CAD) modeler, licensed under the [[LGPL|LGPLv2+]] license. It is primarily made for mechanical engineering design, but also serves a wide range of uses wherever you need to model 3D objects with precision and control over modeling history. + +FreeCAD has been under development since 2002, with the project founded by Jürgen Riegel, Werner Mayer, and Yorik van Havre. The current stable version is '''1.1.x''' (released March 2026), with active development towards version 1.2. FreeCAD runs on Windows, macOS, and Linux, and is available in over 20 languages. + +FreeCAD features a modern, comprehensive [[Workbenches|workbench-based]] interface built on the Qt framework. Its core geometry engine is powered by [[Open_CASCADE|Open CASCADE Technology]] (OCCT), which provides robust support for [[B-rep|Boundary Representation]] (BRep), [[NURBS|Non-uniform rational basis spline]] (NURBS) curves and surfaces, complex boolean operations, and native support for industry-standard formats like [[STEP|STEP]] and [[IGES|IGES]]. + +Unlike many commercial CAD packages, FreeCAD is completely free — both as in "free speech" and "free beer". Its development is driven by a global community of volunteers and supported by the FreeCAD Project Association (FPA). The source code is hosted on [https://github.com/FreeCAD/FreeCAD GitHub]. + +=== Key Capabilities === + +* '''Parametric Modeling:''' All objects in FreeCAD are natively parametric. Their shapes can be driven by [[Property|properties]], formulas via the [[Expressions|expressions engine]], or even depend on other objects. Changes propagate automatically through the model tree. + +* '''Assembly Workbench:''' Since version 1.0 (November 2024), FreeCAD includes a built-in [[Assembly_Workbench|Assembly Workbench]] based on the Ondsel Solver, allowing 3D constraints between parts, assembly of components, and animation. + +* '''Sketcher:''' The [[Sketcher_Workbench|Sketcher]] provides a state-of-the-art 2D constraint-based sketching environment that serves as the foundation for most part design workflows. + +* '''Part Design:''' The [[PartDesign_Workbench|PartDesign Workbench]] enables a feature-based modeling workflow (pads, pockets, revolutions, grooves, fillets, chamfers, etc.). + +* '''BIM:''' The [[BIM_Workbench|BIM Workbench]] (merged from the former Arch and BIM workbenches in version 1.0) provides full [[Building_Information_Modeling|Building Information Modeling]] capabilities with [[IFC|IFC]] compatibility. + +* '''CAM:''' The [[CAM_Workbench|CAM Workbench]] (formerly Path Workbench) generates machine instructions ([[G-code|G-code]]) for [[CNC|CNC]] machining, 3D printing, and other computer-aided manufacturing operations. + +* '''TechDraw:''' The [[TechDraw_Workbench|TechDraw Workbench]] creates production-ready 2D technical drawings from 3D models, with support for dimensions, section views, detail views, and more. + +* '''FEM:''' The [[FEM_Workbench|FEM Workbench]] performs [[Finite_Element_Method|Finite Element Method]] (FEM) analysis using integrated solvers such as CalculiX, Elmer, and Z88. + +* '''Import/Export:''' FreeCAD supports a wide range of file formats including STEP, IGES, OBJ, STL, DXF, DWG, SVG, DAE, IFC, OFF, NASTRAN, VRML, and OpenSCAD CSG, in addition to its native [[FCStd|FCStd]] format. + +FreeCAD has a large and active community. Help and support can be found on the [https://forum.freecad.org FreeCAD Forum], [https://discord.com/invite/w2cTKGzccC Discord], and [https://www.reddit.com/r/FreeCAD Reddit]. The project welcomes contributions of all kinds — code, documentation, translations, and financial support through the [https://fpa.freecad.org FreeCAD Project Association]. + +{{Docnav +|[[Main_Page|Main Page]] +|[[Feature_list|Feature list]] +}} + +{{Userdocnavi{{#translation:}}}} +[[Category:User Documentation{{#translation:}}]] diff --git a/wiki/Feature_list.wikitext b/wiki/Feature_list.wikitext index 29089afedfa..d0809102b07 100644 --- a/wiki/Feature_list.wikitext +++ b/wiki/Feature_list.wikitext @@ -1,22 +1,13 @@ - - - - {{Docnav |[[About_FreeCAD|About FreeCAD]] |[[Installing_on_Windows|Installing on Windows]] }} - This is an extensive, but not complete, list of features which FreeCAD implements. - {{TOCright}} - - -== Release notes == - +== Release notes == * [[Release_notes_1.2|Release 1.2]] - ''Development version with weekly builds'' * '''[[Release_notes_1.1|Release 1.1]] - March 2026''' * [[Release_notes_1.0|Release 1.0]] - November 2024 @@ -32,9 +23,7 @@ This is an extensive, but not complete, list of features which FreeCAD implement * [[Release_notes_0.12|Release 0.12]] - December 2011 * [[Release_notes_0.11|Release 0.11]] - March 2011 -== Key features == - - +== Key features == * [[Image:Feature1.jpg|left]] A complete [https://en.wikipedia.org/wiki/Open_CASCADE Open CASCADE Technology]-based '''geometry kernel''' allowing complex 3D operations on complex shape types, with native support for concepts like [https://en.wikipedia.org/wiki/Boundary_representation Boundary Representation] (BREP), [https://en.wikipedia.org/wiki/Non-uniform_rational_B-spline Non-uniform rational basis spline] (NURBS) curves and surfaces, a wide range of geometric entities, boolean operations and [https://en.wikipedia.org/wiki/Fillet_(mechanics) fillets], and built-in support of [https://en.wikipedia.org/wiki/ISO_10303 STEP] and [https://en.wikipedia.org/wiki/IGES IGES] formats {{clear}} * [[Image:Feature3.jpg|left]] A full '''parametric model'''. All FreeCAD objects are natively parametric, meaning their shape can be based on [[Property|properties]] or even depend on other objects. All changes are recalculated on demand, and recorded by an undo/redo stack. New object types can be added easily, and can even be [[Scripted_objects|fully programmed in Python]].{{clear}} * [[Image:Feature4.jpg|left]] A '''modular architecture''' that allows plugin extensions (modules and workbenches) to add functionality to the core application. An extension can be as complex as a whole new application programmed in C++ or as simple as a [[Power_users_hub|Python script]] or self-recorded [[Macros|macro]]. You have complete access to almost any part of FreeCAD from the built-in '''Python''' interpreter, macros or external scripts, be it [[Topological_data_scripting|geometry creation and transformation]], the 2D or 3D representation of that geometry ([[Scenegraph|scenegraph]]) or even the [[PySide|FreeCAD interface]].{{clear}} @@ -45,95 +34,64 @@ This is an extensive, but not complete, list of features which FreeCAD implement * [[Image:Feature-CAM.jpg|left]] A [[CAM_Workbench|CAM Workbench]] dedicated to mechanical machining for [https://en.wikipedia.org/wiki/Computer-aided_manufacturing Computer Aided Manufacturing] (CAM). Using the CAM Workbench you may output, display and adjust the [https://en.wikipedia.org/wiki/G-code G code] used to control the target machine.{{clear}} * [[Image:Feature_spreadsheet.png|left]] An [[Spreadsheet_Workbench|Integrated Spreadsheet]] and an [[Expressions|expression parser]] which may be used to drive formula-based models and organize model data in a central location.{{clear}} -== General features == - - +== General features == * '''multi-platform'''. FreeCAD runs and behaves exactly the same way on Windows, Linux, macOS and other platforms. - * '''full GUI application'''. FreeCAD has a complete Graphical User Interface based on the [https://www.qt.io/ Qt] framework, with a 3D viewer based on [https://en.wikipedia.org/wiki/Open_Inventor Open Inventor]; allowing fast rendering of 3D scenes and a very accessible scene graph representation. - * '''runs as a command line application'''. In command line mode, FreeCAD runs without its interface but with all its geometry tools. In this mode it has a relatively low memory footprint and can be used, for example, as a server to produce content for other applications. - * '''can be imported as a [[Embedding FreeCAD|Python module]]'''. FreeCAD can be imported into any application that can run Python scripts. As in command line mode, the interface part of FreeCAD is unavailable, but all geometry tools are accessible. - * '''workbench concept'''. In the FreeCAD interface, tools are grouped by [[Workbenches|workbenches]]. This allows you to display only the tools used to accomplish a certain task, keeping the workspace uncluttered and responsive, and allowing the application to load rapidly. - * '''plugin/module framework for late loading of features/data-types'''. FreeCAD is divided into a core application with modules and workbenches that are loaded only when needed. Almost all tools and geometry types are stored in workbenches. Workbenches behave like plugins; in addition to delayed loading, individual workbenches can be added to or removed from an existing installation of FreeCAD. - * '''parametric associative document objects'''. All objects in a FreeCAD document can be defined by parameters. Those parameters can be modified and recomputed at any time. Since object relationships are maintained, the modification of one object will automatically propagate to any dependent objects. - * '''parametric primitive creation'''. Primitive objects such as box, sphere, cylinder, etc. can be created by specifying their geometry constraints. - * '''graphical modification operations'''. FreeCAD can perform translation, rotation, scaling, mirroring, offset (either trivial or as described in [https://www.researchgate.net/publication/240754626_Self-intersection_Removal_in_Triangular_Mesh_Offsetting Jung/Shin/Choi]) or shape conversion, in any plane of the 3D space. - * '''[[Constructive solid geometry]] (boolean operations)'''. FreeCAD can do constructive solid geometry operations (union, difference, intersect). - * '''graphical creation of planar geometry'''. Lines, wires, rectangles, B-splines, and circular or elliptic arcs can be created graphically in any plane of the 3D space. - * '''modeling with straight or revolved''' '''extrusions''', '''sections''' and '''fillets'''. - * '''topological components''' like '''vertices''', '''edges''', '''wires''' and '''planes'''. - * '''testing and repairing'''. FreeCAD has tools for testing meshes (solid test, non-two-manifolds test, self-intersection test) and for repairing meshes (hole filling, uniform orientation). - * '''annotations'''. FreeCAD can insert annotations for text or dimensions. - * '''Undo/Redo framework'''. Everything in FreeCAD is undo/redoable, with user access to the undo stack. Multiple steps can be undone at one time. - * '''transaction oriented'''. The undo/redo stack stores document transactions, not single actions, allowing each tool to define exactly what must be undone or redone. - * '''built-in [[Scripting|scripting]] framework'''. FreeCAD features a built-in [http://www.python.org/ Python] interpreter, with an API that covers almost any part of the application, the interface, the geometry and the representation of this geometry in the 3D viewer. The interpreter can run complex scripts as well as single commands; entire workbenches can be programmed completely in Python. - * '''built-in Python console'''. The Python interpreter includes a console with syntax highlighting, autocomplete and a class browser. Python commands can be issued directly in FreeCAD and immediately return results, permitting script writers to test functionality on the fly, explore the contents of FreeCAD's modules and workbenches and easily learn about FreeCAD internals. - * '''mirrors user interaction'''. Everything the user does in the FreeCAD interface executes Python code, which can be printed on the console and recorded in macros. - * '''full [[Macros|macro]] recording and editing''' capabilities. The Python commands issued when the user manipulates the interface can be recorded, edited if needed, and saved to be reproduced later. - * '''compound (ZIP based) document save format'''. FreeCAD documents are saved with a {{FileName|.[[File Format FCStd|FCStd]]}} extension. The document can contain many different types of information such as geometry, scripts or thumbnail icons. The {{FileName|.FCStd}} file is itself a zip container; a saved FreeCAD file has already been compressed. - * '''fully customizable/scriptable Graphical User Interface'''. The [https://www.qt.io Qt]-based interface of FreeCAD is entirely accessible via the Python interpreter. Aside from simple functions FreeCAD itself provides to workbenches, the entire Qt framework is accessible. The user may perform any operation on the GUI such as creating, adding, docking, modifying or removing widgets and toolbars. - -* '''thumbnailer'''. (currently only Linux systems) FreeCAD document icons show the contents of the file in most file manager applications such as Gnome's Nautilus. - - -* '''modular MSI installer'''. FreeCAD's installer allows flexible installations on Windows systems. Packages for Ubuntu systems are also maintained. - -==Extra Workbenches == +* '''thumbnailer'''. FreeCAD document icons show the contents of the file in most file manager applications (Linux: Nautilus, Windows: File Explorer, macOS: Finder). - -Power users have created various custom [https://www.freecad.org/addons.php external workbenches]. +* '''cross-platform packaging'''. FreeCAD is available through native installers on Windows, macOS (DMG), Linux (AppImage, Snap, Flatpak, and distribution packages), and can be compiled from source on all platforms. +==Extra Workbenches == +Power users have created various custom [https://github.com/FreeCAD/FreeCAD-addons external workbenches]. - {{Docnav |[[About_FreeCAD|About FreeCAD]] |[[Installing_on_Windows|Installing on Windows]] }} - {{Userdocnavi{{#translation:}}}} -[[Category:User Documentation{{#translation:}}]] \ No newline at end of file +[[Category:User Documentation{{#translation:}}]] diff --git a/wiki/Getting_started.wikitext b/wiki/Getting_started.wikitext index d82972522d2..8b7351d1523 100644 --- a/wiki/Getting_started.wikitext +++ b/wiki/Getting_started.wikitext @@ -1,50 +1,33 @@ - - - - {{Docnav |[[Version_Migration|Version Migration]] |[[Mouse_navigation|Mouse navigation]] }} - {{TOCright}} - - -==Foreword== - +==Foreword== FreeCAD is a 3D [[About_FreeCAD|parametric modeling application]]. It is primarily made for mechanical design, but also serves all other uses where you need to model 3D objects with precision and control over modeling history. - FreeCAD has been under development since 2002, and it offers a large list of [[Feature_list|features]]. Capabilities are still missing but it is powerful enough for hobbyist use, and small workshops. There is a fast-growing community of enthusiastic users who participate in the [https://forum.freecad.org FreeCAD forum], and you can find [https://forum.freecad.org/viewforum.php?f=24 many examples] of quality projects developed with FreeCAD there. - Like all free software projects, FreeCAD depends on its community to grow, gain features, and fix bugs. Don't forget this when using FreeCAD: if you like it, you can [[Donate|donate]] and [[Help_FreeCAD|help FreeCAD]] in various ways, such as writing documentation or making translations. - See also: - * [[Migrating_to_FreeCAD_from_Fusion360|Migrating to FreeCAD from Fusion360]] * [[Which_workbench_should_I_choose|Which workbench should I choose?]] * [[Tutorials|Tutorials]] * [[Video_tutorials|Video tutorials]] -==Installing== +==Installing== - First of all, download and install FreeCAD. See the [[Download|Download]] page for information on current versions and updates, and the installation instructions for your operating system ([[Installing_on_Windows|Windows]], [[Installing_on_Linux|Linux]] or [[Installing_on_Mac|macOS]]). FreeCAD is available from the package managers of many Linux distributions. As FreeCAD is open-source, you can also grab the source code and [[Compiling|compile]] it yourself. -==Exploring the interface== - - +==Exploring the interface== [[File:FreeCAD_interface_base_divisions.svg|1024px]] - {{Caption|The standard FreeCAD interface}} - {{Emphasis|See a full explanation in [[Interface|Interface]].}} :1. The [[Main_View_Area|Main View Area]], which can contain different tabbed windows, principally the [[3D_View|3D view]]. :2. The [[3D_View|3D View]], showing the geometrical objects in the document. @@ -58,49 +41,33 @@ First of all, download and install FreeCAD. See the [[Download|Download]] page f :10. The [[Std_Workbench|Workbench Selector]], where you select the active [[Workbenches|Workbench]]. :11. The [[Standard_Menu|Standard Menu]], which holds basic operations of the program. - The main concept behind the FreeCAD interface is that it is separated into [[Workbenches|workbenches]]. A workbench is a collection of tools suited for a specific task, such as working with [[Mesh_Workbench|meshes]], or drawing [[Draft_Workbench|2D objects]], or [[Sketcher_Workbench|constrained sketches]]. You can switch the current workbench with the [[Std_Workbench|Workbench Selector]]. You can [[Interface_Customization|customize]] the tools included in each workbench, add tools from other workbenches or even self-created tools, that we call [[Macros|macros]]. Widely used starting points are the [[PartDesign_Workbench|PartDesign Workbench]] and [[Part_Workbench|Part Workbench]]. - -When you start FreeCAD for the first time, you are presented with the Start page. Here is what it looks like (the screenshot shows version 0.19, but the layout is similar in current versions): +When you start FreeCAD for the first time, you are presented with the Start page. Here is what it looks like (the screenshot shows version 1.0, but the layout is similar in current versions): - [[File:Start_center_0.19_screenshot.png|600px]] - The Start page allows you to quickly jump to one of the most common workbenches, open one of the recent files, or see the latest news from the FreeCAD world. You can change the default workbench in the [[Preferences_Editor|preferences]]. -== Navigating in the 3D space == - - +== Navigating in the 3D space == FreeCAD has several [[Mouse_navigation|navigation modes]] available, that change the way you use your mouse to interact with the objects in the 3D view and the view itself. One of them is specifically made for [[Mouse_navigation#Touchpad_navigation|touchpads]], where the middle mouse button is not used. The default navigation mode is [[Mouse_navigation#CAD_navigation|CAD navigation]]. You can quickly change the current navigation mode by using the {{Button|[[File:NavigationCAD_dark.svg|16px]]}} button in the [[Status_Bar|Status Bar]] or by right-clicking an empty area of the [[3D_View|3D view]]. - You also have several view presets (top view, front view, etc) available in the View menu, on the View toolbar, and by numeric shortcuts ({{KEY|1}}, {{KEY|2}}, etc...). By right-clicking on an object or on an empty area of the 3D view, you have quick access to some common operations, such as setting a particular view, or locating an object in the Tree view. -==First steps with FreeCAD== - - +==First steps with FreeCAD== FreeCAD's focus is to allow you to make high-precision 3D models, to keep tight control over those models (being able to go back into modelling history and change parameters), and eventually to build those models (via 3D printing, CNC machining or even construction worksite). It is therefore very different from some other 3D applications made for other purposes, such as animation film or gaming. Its learning curve can be steep, especially if this is your first contact with 3D modeling. If you are stuck at some point, don't forget that the friendly community of users on the [https://forum.freecad.org FreeCAD forum] might be able to get you out in no time. - -The workbench you will start using in FreeCAD depends on the type of job you need to do: If you are going to work on mechanical models, or more generally any small-scale objects, you'll probably want to try the [[PartDesign_Workbench|PartDesign Workbench]]. If you will work in 2D, then switch to the [[Draft_Workbench|Draft Workbench]], or the [[Sketcher_Workbench|Sketcher Workbench]] if you need constraints. If you want to do BIM, launch the [[BIM_Workbench|BIM Workbench]]. And if you come from the OpenSCAD world, try the [[OpenSCAD_Workbench|OpenSCAD Workbench]]. There are also many community-developed [https://www.freecad.org/addons.php external workbenches] available. +The workbench you will start using in FreeCAD depends on the type of job you need to do: If you are going to work on mechanical models, or more generally any small-scale objects, you'll probably want to try the [[PartDesign_Workbench|PartDesign Workbench]]. If you will work in 2D, then switch to the [[Draft_Workbench|Draft Workbench]], or the [[Sketcher_Workbench|Sketcher Workbench]] if you need constraints. If you want to do BIM, launch the [[BIM_Workbench|BIM Workbench]]. And if you come from the OpenSCAD world, try the [[OpenSCAD_Workbench|OpenSCAD Workbench]]. There are also many community-developed [https://github.com/FreeCAD/FreeCAD-addons external workbenches] available. - You can switch workbenches at any time, and also [[Interface_Customization|customize]] your favorite workbench to add tools from other workbenches. -==Working with the PartDesign and Sketcher workbenches== - - +==Working with the PartDesign and Sketcher workbenches== The [[PartDesign_Workbench|PartDesign Workbench]] is made to build complex objects, starting from simple shapes, and adding or removing pieces (called "features"), until you get to your final object. All the features you applied during the modelling process are stored in a separate view called the [[Document_structure|tree view]], which also contains the other objects in your document. You can think of a PartDesign object as a succession of operations, each one applied to the result of the preceding one, forming one big chain. In the tree view, you see your final object, but you can expand it and retrieve all preceding states, and change any of their parameter, which automatically updates the final object. - The PartDesign workbench makes heavy use of another workbench, the [[Sketcher_Workbench|Sketcher Workbench]]. The sketcher allows you to draw 2D shapes, which are defined by applying Constraints to the 2D shape. For example, you might draw a rectangle and set the size of a side by applying a length constraint to one of the sides. That side then cannot be resized anymore (unless the constraint is changed). - Those 2D shapes made with the sketcher are used a lot in the PartDesign workbench, for example to create 3D volumes, or to draw areas on the faces of your object that will then be hollowed from its main volume. This is a typical PartDesign workflow: - # Create a new sketch # Draw a closed shape (make sure all points are joined) # Close the sketch @@ -111,31 +78,21 @@ Those 2D shapes made with the sketcher are used a lot in the PartDesign workbenc # Close the sketch # Create a pocket from the second sketch, on the first object - Which gives you an object like this: - [[Image:Partdesign_example.jpg|600px]] - - At any moment, you can select the original sketches and modify them, or change the extrusion parameters of the pad or pocket operations, which will update the final object. -==Working with the Draft and BIM workbenches== - - +==Working with the Draft and BIM workbenches== The [[Draft_Workbench|Draft Workbench]] and [[BIM_Workbench|BIM Workbench]] behave a bit differently than the other workbenches above, although they follow the same rules, which are common to all of FreeCAD. In short, while the Sketcher and PartDesign are made primarily to design single pieces, Draft and BIM are made to ease your work when working with several, simpler objects. - The [[Draft_Workbench|Draft Workbench]] offers you 2D tools somewhat similar to what you can find in traditional 2D CAD applications such as [https://en.wikipedia.org/wiki/AutoCAD AutoCAD]. However, 2D drafting being far away from the scope of FreeCAD, don't expect to find there the full array of tools that these dedicated applications offer. Most of the Draft tools work not only in a 2D plane but also in the full 3D space, and benefit from special helper systems such as [[Draft_SelectPlane|Work planes]] and [[Draft_Snap|object snapping]]. - The [[BIM_Workbench|BIM Workbench]] adds [https://en.wikipedia.org/wiki/Building_Information_Modeling BIM] tools to FreeCAD, allowing you to build architectural models with parametric objects. The BIM workbench relies extensively on other modules such as Draft and Sketcher. All the Draft tools are also present in the BIM workbench, and most BIM tools make use of the Draft helper systems. - A typical workflow with BIM and Draft workbenches might be: - # Draw a couple of lines with the Draft Line tool # Select each line and press the Wall tool to build a wall on each of them # Join the walls by selecting them and pressing the BIM Add tool @@ -144,43 +101,29 @@ A typical workflow with BIM and Draft workbenches might be: # Create a window by clicking the Window tool, select a preset in its panel, then click on a face of a wall # Add dimensions by first setting the working plane if necessary, then using the Draft Dimension tool - Which will give you this: - [[Image:Arch_workflow_example.jpg|600px]] - - More on the [[Tutorials|Tutorials]] page. -==Addons== - - +==Addons== Any user can develop their own new features for FreeCAD and make them available to the FreeCAD community as an [[Addon|addon]]. - There are three types of addons: * [[Macros|Macros]]: short snippet of [[Python|Python]] code that provides a new tool or functionality in a single file ending with {{incode|.FCMacro}}. -* [https://www.freecad.org/addons.php Workbenches]: collections of Python files that provide related [[Gui_Command|Gui Commands]] (tools) centered around a particular topic. +* [https://github.com/FreeCAD/FreeCAD-addons Workbenches]: collections of Python files that provide related [[Gui_Command|Gui Commands]] (tools) centered around a particular topic. * [[Preference_Packs|Preference Packs]]: distributable collections of user preferences. -==Scripting== - - +==Scripting== And finally, one of the most powerful features of FreeCAD is the [[Power_users_hub#Scripting_in_FreeCAD|scripting]] environment. From the integrated python console (or from any other external Python script), you can gain access to almost any part of FreeCAD, create or modify geometry, modify the representation of those objects in the 3D scene or access and modify the FreeCAD interface. Python scripting can also be used in [[Macros|macros]], which provide an easy method to create custom commands. -== What's new == - - +== What's new == * See the [[Feature_list#Release_notes|release notes]] for the detailed list of features. - - {{Docnav |[[Version_Migration|Version Migration]] |[[Mouse_navigation|Mouse navigation]] }} - -{{Userdocnavi}} \ No newline at end of file +{{Userdocnavi}} diff --git a/wiki/Main_Page.wikitext b/wiki/Main_Page.wikitext index fa3e9ab268d..d872e7f12ae 100644 --- a/wiki/Main_Page.wikitext +++ b/wiki/Main_Page.wikitext @@ -1,16 +1,10 @@ __NOTOC__ - - -== Introduction == - - +== Introduction == This is the documentation wiki of [https://freecad.org FreeCAD]. There are several ways to use this documentation: by exploring the hubs, by following the manual, or by using the Help menu entries from within FreeCAD. This is a work in progress, written by the community of users and developers of FreeCAD. If you find information that is wrong or missing, please [[Special:MyLanguage/help_FreeCAD|help FreeCAD]]! {{Clear}} -== The hubs == - - +== The hubs == [[Image:Crystal_Clear_app_display.png|64px|left]] [[User_hub|Users hub]]: This page contains documentation useful for FreeCAD users in general: a list of all the workbenches, detailed instructions on how to install and use the FreeCAD application, tutorials, and all you need to get started. {{Clear}} [[Image:Crystal Clear app terminal.png|64px|left]] [[Power_users_hub|Power users hub]]: This page gathers documentation for advanced users and people interested in writing Python scripts. There you will also find a repository of macros, instructions on how to install and use them, and more information about customizing FreeCAD to your specific needs. @@ -18,17 +12,13 @@ This is the documentation wiki of [https://freecad.org FreeCAD]. There are sever [[Image:Crystal Clear app tutorials.png|64px|left]] [[Developer_hub|Developers hub]]: This section contains material for developers: How to compile FreeCAD yourself, how the FreeCAD source code is structured, how to navigate the source code, how to develop new workbenches, and embed FreeCAD in your own application. Note that the information in this section may be obsolete. For up-to-date information consult the [https://freecad.github.io/DevelopersHandbook/ Developers Handbook]. {{Clear}} -== Manual == - - -[[Image:Crystal_Clear_manual.png|64px|left]] [[Manual:Introduction|The FreeCAD manual]] is another, more linear way to present the information contained in this wiki. It is designed to be read like a book, and will gently introduce you to many other pages from the hubs above. +== Manual == + [[Image:Crystal_Clear_manual.png|64px|left]] [[Manual:Introduction|The FreeCAD manual]] is another, more linear way to present the information contained in this wiki. It is designed to be read like a book, and will gently introduce you to many other pages from the hubs above. {{Clear}} -== Table of contents == - - +== Table of contents == The Table of contents is available in several languages: - + {|border="0" width="100%" style="background:transparent;" |- | @@ -57,13 +47,9 @@ The Table of contents is available in several languages: * [[Image:Flag-tr.jpg]] [[Online Help Toc/tr|İçindekiler]] * [[Image:Flag-uk.jpg]] [[Online Help Toc/uk|Вміст]] |} - -== Get involved == - -=== How to participate === - - +== Get involved == +=== How to participate === There is plenty to do inside the FreeCAD project, if you are interested in helping us. Of course, there are programming tasks for C++ or Python programmers, but there are also many things you can do even if you cannot code, such as * writing documentation and [[WikiPages|editing the wiki (en)]] * helping newcomers @@ -71,20 +57,13 @@ There is plenty to do inside the FreeCAD project, if you are interested in helpi * helping with the packaging of the latest release of FreeCAD for your favourite operating system * helping other people around you to discover FreeCAD. - -The [[Special:MyLanguage/help_FreeCAD|help FreeCAD]] page describes it all with more details. Starting from 2016, FreeCAD also participates in the [[Google_Summer_of_Code|Google Summer of Code]]. - -=== Source code === +The [[Special:MyLanguage/help_FreeCAD|help FreeCAD]] page describes it all with more details. FreeCAD has regularly participated in the [[Google_Summer_of_Code|Google Summer of Code]] since 2016, offering mentoring and project opportunities for new contributors. - -FreeCAD can be compiled on all platforms using [https://cmake.org/ CMake]. The source code is [https://en.wikipedia.org/wiki/GNU_Lesser_General_Public_License LGPL]-licensed and hosted on [https://github.com/FreeCAD/FreeCAD GitHub] and mirrored on [https://gitlab.com/freecad/FreeCAD GitLab], [https://sourceforge.net/projects/free-cad/ SourceForge] and [https://codeberg.org/FreeCAD/FreeCAD CodeBerg]. There are build instructions for [[Compile_on_Windows|Windows]], [[Compile_on_Linux|Linux]] and [[Compile_on_MacOS|MacOS]]. The source code documentation is [https://freecad.org/api/ hosted here], generated by [[Doxygen|Doxygen]], and [[Source_documentation|documented on the wiki]]. +=== Source code === +FreeCAD can be compiled on all platforms using [https://cmake.org/ CMake]. The source code is [https://en.wikipedia.org/wiki/GNU_Lesser_General_Public_License LGPL]-licensed and hosted on [https://github.com/FreeCAD/FreeCAD GitHub]. There are build instructions for [[Compile_on_Windows|Windows]], [[Compile_on_Linux|Linux]] and [[Compile_on_MacOS|MacOS]]. The source code documentation is [https://freecad.github.io/DevelopersHandbook/ hosted here] as part of the [[Developers_Handbook|Developers Handbook]], generated by [[Doxygen|Doxygen]], and also [[Source_documentation|documented on the wiki]]. -=== About the development === - - +=== About the development === The [[Feature_list#Release_notes|release notes]] provide individual change logs, while the [https://github.com/FreeCAD/FreeCAD/issues FreeCAD's GitHub issue tracker] shows current progress towards the next release. Broader information about the FreeCAD codebase and activity can be checked out on [https://github.com/FreeCAD/FreeCAD/pulse its GitHub's Insight page]. All development communication happens on [https://github.com/FreeCAD/FreeCAD/ GitHub], please go there if you are interested in participating. - - {{Userdocnavi{{#translation:}}}} -[[Category:Documentation{{#translation:}}]] \ No newline at end of file +[[Category:Documentation{{#translation:}}]]