Main Page: Difference between revisions

From FreeCAD Documentation
(Followed some guidelines of http://sourceforge.net/blog/what-does-it-do/)
No edit summary
 
(127 intermediate revisions by 24 users not shown)
Line 1: Line 1:
__NOTOC__
= FreeCAD =
<languages/>
<translate>


<!--T:1-->
<div class="main-menu">
== Introduction ==
This is the documentation wiki of [http://www.freecadweb.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 == <!--T:3-->
{{Languages-top| {{cn|Main Page/cn}} {{de|Main Page/de}} {{es|Main Page/es}} {{fr|Main Page/fr}} {{it|Main Page/it}} {{pl|Main Page/pl}} {{ru|Main Page/ru}} {{se|Main Page/se}} {{tr|Main Page/tr}} }}


<!--T:4-->
<i>A parametric 3D CAD modeler</i>
[[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.
{{Clear}}
[[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.
{{Clear}}


== Manual == <!--T:5-->
</div>


<!--T:14-->
<div class="main-toolbox">
[[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. [https://www.gitbook.com/book/yorikvanhavre/a-freecad-manual/details ebook versions] are also available, as well as [https://www.freecadweb.org/manual/ a couple of translations in pdf format].
{{Clear}}


== Table of contents == <!--T:15-->
{{downloads}}

{{screenshot|Rim_bling.png|a screenshot showing version 0.12}}

{{newsbox}}

{{feedsbox}}

{{mantisbox}}

{{facebookbox}}

</div>

<div class="main-content">

'''FreeCAD''' is a general purpose [http://en.wikipedia.org/wiki/Parametric_feature_based_modeler feature-based, parametric 3D modeler] for [http://en.wikipedia.org/wiki/CAD CAD], MCAD, [http://en.wikipedia.org/wiki/CAx CAx], [http://en.wikipedia.org/wiki/Computer-aided_engineering CAE] and [http://en.wikipedia.org/wiki/Product_Lifecycle_Management PLM], aimed directly at [http://en.wikipedia.org/wiki/Mechanical_engineering mechanical engineering] and [http://en.wikipedia.org/wiki/Product_design product design] but also fits a wider range of uses in engineering, such as architecture or other engineering specialties. It is 100% [http://en.wikipedia.org/wiki/Open_source Open Source] and extremely modular, allowing for very advanced extension and customization.

FreeCAD is based on [http://en.wikipedia.org/wiki/Open_CASCADE OpenCasCade], a powerful geometry kernel, features an [http://en.wikipedia.org/wiki/Open_Inventor Open Inventor]-compliant 3D scene representation model provided by the [http://en.wikipedia.org/wiki/Coin3D Coin 3D] library, and a broad [http://en.wikipedia.org/wiki/Python_(programming_language) Python] API. The interface is built with [http://en.wikipedia.org/wiki/Qt_(framework) Qt]. FreeCAD runs exactly the same way on Windows, Mac OSX and Linux platforms.

[[Image:Right arrow.png]] [[About FreeCAD|Learn more here...]]

== Key features ==

* [[Image:Feature1.jpg|left]] A complete [http://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 brep, nurbs, boolean operations and fillets {{clear}}
* [[Image:Feature6.jpg|left]] A '''modular architecture''' that allow plugins (modules) to add functionality to the core application. Those extensions can be as complex as whole new applications or as simple as [[Scripting|Python scripts]] or self-recorded [[macros]] {{clear}}
* [[Image:Feature3.jpg|left]] A full '''parametric model''' allowing any type of parameter-driven custom objects, that can even be [[Scripted objects|fully programmed in Python]]{{clear}}
* [[Image:Feature4.jpg|left]] Complete access from '''Python''' built-in interpreter, macros or external scripts to almost any part of FreeCAD, being [[Topological data scripting|geometry creation and transformation]], the 2D or 3D representation of that geometry ([[scenegraph]]) or even the [[PyQt|FreeCAD interface]] {{clear}}
* [[Image:Feature5.jpg|left]] Import/export to '''standard formats''' such as [http://en.wikipedia.org/wiki/ISO_10303 STEP], [http://en.wikipedia.org/wiki/IGES IGES], [http://en.wikipedia.org/wiki/Obj OBJ], [http://en.wikipedia.org/wiki/Dxf DXF], [http://en.wikipedia.org/wiki/Svg SVG], [http://en.wikipedia.org/wiki/STL_(file_format) STL], [http://en.wikipedia.org/wiki/COLLADA DAE], [http://en.wikipedia.org/wiki/Industry_Foundation_Classes IFC] or [http://people.sc.fsu.edu/~jburkardt/data/off/off.html OFF], in addition to FreeCAD's native [[Fcstd file format]].{{clear}}
* [[Image:Feature7.jpg|left]] A [[Sketcher Workbench|Sketcher]] with constraint-solver, allowing to sketch geometry-constrained 2D shapes. The sketcher currently allows you to build several types of constrained geomerty, and use them as a base to build other objects throughout FreeCAD.{{clear}}
* [[Image:Feature9.jpg|left]] A [[Robot Workbench|Robot simulation]] module that allows to study robot movements. The robot module already has an extended graphical interface allowing GUI-only workflow.{{clear}}

== In development ==

* [[Image:Feature8.jpg|left]] A [[Drawing Module|Drawing sheets]] module that permit to put 2D views of your 3D models on a sheet. This modules then produces ready-to-export SVG or PDF sheets. The module is still sparse but already features a powerful Python functionality.{{clear}}
* [[Image:Feature-raytracing.jpg|left]] A [[Raytracing Module|Rendering]] module that can export 3D objects for rendering with external renderers. Currently only supports [http://en.wikipedia.org/wiki/POV-Ray povray], but is expected to be extended to other renderers in the future.{{clear}}
* [[Image:Feature-arch.jpg|left]] An [[Arch Module|Architecture]] module that allows [http://en.wikipedia.org/wiki/Building_Information_Modeling BIM]-like workflow, with [http://en.wikipedia.org/wiki/Industry_Foundation_Classes IFC] compatibility. The making of the Arch module is heavily discussed by the community [http://sourceforge.net/apps/phpbb/free-cad/viewtopic.php?f=10&t=821 here].{{clear}}
* [[Image:Feature-assembly.jpg|left]] An [[Assembly project|Assembly]] module that allows to work with multiple shapes, multiple documents, multiple files, multiple relationships...{{clear}}

== Manual ==

The FreeCAD manual is a work-in-progress community effort to provide state-of-the-art documentation about using FreeCAD, and is already available in several languages. It still lacks much information, so feel free to join and [[Help FreeCAD|contribute]]!


<!--T:6-->
The Table of contents is available in several languages:
</translate>
{|border="0" width="100%" style="background:transparent;"
{|border="0" width="100%" style="background:transparent;"
|-
|-
|
|
* [[Image:Flag-en.jpg]] [[Online Help Toc|Table of contents]]
* [[Image:Flag-en.jpg]] [[Online Help Toc|Table of contents]]
* [[Image:Flag-cn.jpg]] [[Online Help Toc/cn|目录]]
* [[Image:Flag-bg.jpg]] [[Online Help Toc/bg|Съдържание]]
* [[Image:Flag-cn.jpg‎]] [[Online_Help_Toc/zh|目錄]] zh
* [[Image:Flag-cn.jpg]] [[Online Help Toc/zh-cn|目录]] zh-cn
* [[Image:Flag-cn.jpg‎]] [[Online_Help_Toc/zh-tw|目錄]] zh-tw
* [[Image:Flag-cs.jpg]] [[Online Help Toc/cs|Obsah]]
* [[Image:Flag-de.jpg]] [[Online Help Toc/de|Inhaltsverzeichnis]]
* [[Image:Flag-de.jpg]] [[Online Help Toc/de|Inhaltsverzeichnis]]
* [[Image:Flag-es.jpg]] [[Online Help Toc/es|Índice de contenidos]]
* [[Image:Flag-es.jpg]] [[Online Help Toc/es|Índice de contenidos]]
||
||
* [[Image:Flag-fr.jpg]] [[Online Help Toc/fr|Table des matières]]
* [[Image:Flag-fr.jpg]] [[Online Help Toc/fr|Table des matières]]
* [[Image:Flag-it.jpg]] [[Online Help Toc/it|Indice dei contenuti]]
* [[Image:Flag-hr.jpg]] [[Online Help Toc/hr|Sadržaj]]
* [[Image:Flag-jp.jpg]] [[Online Help Toc/jp|目次]]
* [[Image:Flag-id.jpg]] [[Online Help Toc/id|Daftar isi]]
* [[Image:Flag-it.jpg]] [[Online Help Toc/it|Sommario]]
* [[Image:Flag-jp.jpg]] [[Online Help Toc/ja|目次]] ja
* [[Image:Flag-ko.jpg]] [[Online Help Toc/ko|온라인 도움말]]
* [[Image:Flag-pl.jpg]] [[Online Help Toc/pl|Spis Treści]]
* [[Image:Flag-pl.jpg]] [[Online Help Toc/pl|Spis Treści]]
||
||
* [[Image:Flag-pt.jpg]] [[Online Help Toc/pt|Tabela de conteúdos]] pt
* [[Image:Flag-pt-br.jpg]] [[Online Help Toc/pt-br|Índice]] pt-br
* [[Image:Flag-ro.jpg]] [[Online_Help_Toc/ro|Cuprins]]
* [[Image:Flag-ru.jpg]] [[Online Help Toc/ru|Содержание]]
* [[Image:Flag-ru.jpg]] [[Online Help Toc/ru|Содержание]]
* [[Image:Flag-se.jpg]] [[Online Help Toc/se|Innehallsforteckning]]
* [[Image:Flag-sv.jpg]] [[Online Help Toc/sv|Innehallsforteckning]]
* [[Image:Flag-tr.jpg]] [[Online Help Toc/tr|İçindekiler]]
* [[Image:Flag-tr.jpg]] [[Online Help Toc/tr|İçindekiler]]
* [[Image:Flag-uk.jpg]] [[Online Help Toc/uk|Вміст]]
|}
|}
<translate>


== More ==
== Get involved == <!--T:7-->


=== About the development ===
=== How to participate === <!--T:8-->


<!--T:9-->
Check the [[Development roadmap]] for news about what is being planned, the [http://sourceforge.net/apps/mantisbt/free-cad/changelog_page.php Changelog] and [http://sourceforge.net/apps/mantisbt/free-cad/roadmap_page.php Roadmap] mantis pages to see the progresses towards next release, or the [http://www.ohloh.net/p/freecad Project statistics] for even more information about the FreeCAD codebase. All the development communication happens on the [http://sourceforge.net/apps/phpbb/free-cad/ forum], so be sure to visit it if you are interested in participating.
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
* translating the application and documentation
* helping with the packaging of the latest release of FreeCAD for your favourite operating system
* helping other people around you to discover FreeCAD.


<!--T:16-->
=== Source code ===
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 === <!--T:10-->
FreeCAD can be compiled using cMake or autotools, the git link is git://free-cad.git.sourceforge.net/gitroot/free-cad/free-cad and there are build instructions for [[CompileOnWindows|Windows]], [[CompileOnUnix|Unix/Linux]] and [[CompileOnMac|MacOSX]].


<!--T:11-->
=== Help wanted ===
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 [http://www.freecadweb.org/api/ hosted here], generated by [[Doxygen|Doxygen]], and [[Source_documentation|documented on the wiki]].


=== About the development === <!--T:12-->
FreeCAD would [[Help FreeCAD|benefit greatly from your help]], for example by testing and [http://sourceforge.net/apps/mantisbt/free-cad/main_page.php reporting bugs], or helping with extending and bettering the [[User hub|documentation destinated to newcomers]], for example by writing or recording [[tutorials]]. Another problem we have, is lack of people to build and test FreeCAD on Mac OSX. If you have a mac, please [[CompileOnMac|help us]]! You are also welcome to help [[Localisation|translating FreeCAD]] in your language. If you can program in C++ or Python, there is plenty to do, drop us a note on the [http://sourceforge.net/apps/phpbb/free-cad/ forum]!


<!--T:13-->
=== Follow FreeCAD anywhere! ===
Check the [[Development roadmap|Development roadmap]] for news about what is being planned, the [http://www.freecadweb.org/tracker/changelog_page.php Changelog] and [http://www.freecadweb.org/tracker/roadmap_page.php Roadmap] pages on the [http://www.freecadweb.org/tracker FreeCAD tracker] to see the progress towards next release, or the [http://www.ohloh.net/p/freecad Project statistics] for even more information about the FreeCAD codebase. All the development communication happens on the [http://forum.freecadweb.org forum], so be sure to visit it if you are interested in participating.


[[Image:Twitter.png|link=http://www.twitter.com/FreeCADNews]] [[Image:Facebook.png|link=http://www.facebook.com/FreeCAD]] [[Image:Youtube.png|link=http://www.youtube.com/user/FreeCADNews]] [[Image:Googleplus.png|24px|link=http://plus.google.com/u/0/107660967460246172334]]


</div>
</translate>
{{Userdocnavi{{#translation:}}}}

[[Category:Documentation{{#translation:}}]]
__NOTOC__

Latest revision as of 21:46, 18 September 2023

Introduction

This is the documentation wiki of 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 help FreeCAD!

The hubs

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.

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.

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.

Manual

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. ebook versions are also available, as well as a couple of translations in pdf format.

Table of contents

The Table of contents is available in several languages:

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 editing the wiki (en)
  • helping newcomers
  • translating the application and documentation
  • helping with the packaging of the latest release of FreeCAD for your favourite operating system
  • helping other people around you to discover FreeCAD.

The help FreeCAD page describes it all with more details. Starting from 2016, FreeCAD also participates in the Google Summer of Code.

Source code

FreeCAD can be compiled on all platforms using CMake. The source code is LGPL-licensed and hosted on GitHub and mirrored on GitLab, SourceForge and CodeBerg. There are build instructions for Windows, Linux and MacOS. The source code documentation is hosted here, generated by Doxygen, and documented on the wiki.

About the development

Check the Development roadmap for news about what is being planned, the Changelog and Roadmap pages on the FreeCAD tracker to see the progress towards next release, or the Project statistics for even more information about the FreeCAD codebase. All the development communication happens on the forum, so be sure to visit it if you are interested in participating.