Main Page: Difference between revisions

From FreeCAD Documentation
mNo edit summary
No edit summary
(34 intermediate revisions by 5 users not shown)
Line 1: Line 1:
__NOTOC__
<languages/>
<languages/>

<translate>
<translate>


== Introduction == <!--T:1-->
== Introduction == <!--T:1-->
This is the documentation wiki of [http://www.freecadweb.org FreeCAD]. You have two main ways to browse through the documentation: by exploring user hubs, or by following the manual. It 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]]!
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}}

<!--T:2-->
__NOTOC__


== User hubs == <!--T:3-->
== The hubs == <!--T:3-->


<!--T:4-->
<!--T:4-->
[[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.
[[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}}
{{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. You will also find there a repository of macros, instructions on how to install and use them, and more information about customizing FreeCAD to your specific needs.
[[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}}
{{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 and how to navigate in it, and how to develop new workbenches, or embed FreeCAD in your own application.
[[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}}
{{Clear}}


Line 22: Line 20:


<!--T:14-->
<!--T:14-->
[[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 made 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].
[[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}}
{{Clear}}


Line 35: Line 33:
* [[Image:Flag-en.jpg]] [[Online Help Toc|Table of contents]]
* [[Image:Flag-en.jpg]] [[Online Help Toc|Table of contents]]
* [[Image:Flag-bg.jpg]] [[Online Help Toc/bg|Съдържание]]
* [[Image:Flag-bg.jpg]] [[Online Help Toc/bg|Съдържание]]
* [[Image:Flag-cn.jpg]] [[Online Help Toc/cn|目]] cn (obsolete - please use zh-cn)
* [[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-cn|目录]] zh-cn
* [[Image:Flag-cn.jpg ‎]] [[Online_Help_Toc/zh-tw|目錄]] zh-tw
* [[Image:Flag-cn.jpg‎]] [[Online_Help_Toc/zh-tw|目錄]] zh-tw
* [[Image:Flag-cs.jpg]] [[Online Help Toc/cs|Obsah]]
* [[Image:Flag-cs.jpg]] [[Online Help Toc/cs|Obsah]]
* [[Image:Flag-hr.jpg]] [[Online Help Toc/hr|Sadržaj]]
||
* [[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-ro.jpg]] [[Online_Help_Toc/ro|Cuprins]]
* [[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-hr.jpg]] [[Online Help Toc/hr|Sadržaj]]
* [[Image:Flag-id.jpg]] [[Online Help Toc/id|Daftar isi]]
* [[Image:Flag-it.jpg]] [[Online Help Toc/it|Sommario]]
* [[Image:Flag-it.jpg]] [[Online Help Toc/it|Sommario]]
* [[Image:Flag-jp.jpg]] [[Online Help Toc/jp|目次]] jp
* [[Image:Flag-jp.jpg]] [[Online Help Toc/ja|目次]] ja
* [[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-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-sv.jpg]] [[Online Help Toc/sv|Innehallsforteckning]] sv
* [[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|Інтернет Допомога]]
* [[Image:Flag-uk.jpg]] [[Online Help Toc/uk|Вміст]]
|}
|}
<translate>
<translate>
Line 77: Line 76:


<!--T:11-->
<!--T:11-->
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] and [https://codeberg.org/FreeCAD/FreeCAD CodeBerg]. There are build instructions for [[Compile_on_Windows|Windows]], [[Compile_on_Linux/Unix|Unix/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]].
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] 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-->
=== About the development === <!--T:12-->

Revision as of 15:08, 26 November 2021

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 following table lists all the articles of this wiki that form the backbone of the offline documentation shipped with the FreeCAD application. It is already 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. The Contributors hub page is another effort to gather the possible ways to help and contribute to the FreeCAD project.

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