# FreeCAD-documentation
**Repository Path**: BinGo2019/FreeCAD-documentation
## Basic Information
- **Project Name**: FreeCAD-documentation
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: CC0-1.0
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No
## Statistics
- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-09-28
- **Last Updated**: 2024-09-28
## Categories & Tags
**Categories**: Uncategorized
**Tags**: None
## README
# The FreeCAD documentation
**Note**: This repository contains an automatic conversion of the FreeCAD wiki located at https://wiki.freecadweb.org to the [markdown format](https://en.wikipedia.org/wiki/Markdown). The conversion is done automatically through the [migrate.py](./migrate.py) script located within this repository. The script downloads the wiki contents in XML format using the MediaWiki API and uses [pandoc](https://pandoc.org/) to convert between MediaWiki and markdown formats. This is a work in progress towards a more usable and portable version of the documentation, to be used from within FreeCAD through the [Help module](https://github.com/yorikvanhavre/FreeCAD-Help).
This documentation can be installed via the FreeCAD [addons manager](wiki/Std_AddonMgr.md) for offline browsing.
## Introduction
This is the official documentation of [FreeCAD](http://www.freecadweb.org). There are several ways to use this documentation: by exploring the **hubs**, by following the **manual**, or by **searching** for a specific page. The **Help menu** entries from within FreeCAD also allow you to browse this documentation, online or offline. This documentation 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](Special:MyLanguage/help_FreeCAD.md)!
## The hubs
#### 
[Users hub](wiki/User_hub.md)
This page contains documentation useful
for FreeCAD users in general:
[frequently](wiki/Frequently_asked_questions.md) [asked](wiki/Frequently_asked_questions.md) [questions](wiki/Frequently_asked_questions.md),
a list of all the [workbenches](wiki/Workbenches.md),
detailed instructions on how to [install](wiki/Installing.md)
and use the FreeCAD application, [tutorials](wiki/Category_Tutorials.md),
[commands](wiki/List_of_Commands.md) [reference](wiki/List_of_Commands.md),
and all you need to get started.
#### 
[Power users hub](wiki/Power_users_hub.md)
This page gathers documentation for advanced users and people interested in writing [Python](https://python.org) code. There you will also find a repository of [macros](wiki/Macro.md), instructions on how to install and use them, [Python API](wiki/Category_API.md) documentation, and more information about customizing and extending FreeCAD to your specific needs.
#### 
[Developers hub](wiki/Developer_hub.md)
This section contains material for developers who want to work with the C++/Python FreeCAD source code: How to [compile FreeCAD](wiki/Compiling.md) yourself, how the source code is structured, how to navigate it, how to develop new workbenches, and embed FreeCAD in your own application.
## Manual
#### 
[The FreeCAD manual](wiki/Manual_Introduction.md)
The 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](https://www.gitbook.com/book/yorikvanhavre/a-freecad-manual/details) are also available, as well as [a couple of translations in pdf format](https://www.freecadweb.org/manual/).
## Translations
This documentation is fully translatable by users to other languages, and is in a continuous process of translation. Several partially or fully translated versions of this documentation are available:
| | | |
|---|---|---|
|  [Croatian / hrvatski](wiki/translations/hr/Main_Page.md) |  [Ukrainian / українська](wiki/translations/uk/Main_Page.md) |  [Czech / čeština](wiki/translations/cs/Main_Page.md) |
|  [Korean / 한국어](wiki/translations/ko/Main_Page.md) |  [Portuguese / português](wiki/translations/pt/Main_Page.md) |  [Bulgarian / български](wiki/translations/bg/Main_Page.md) |
|  [Turkish / Türkçe](wiki/translations/tr/Main_Page.md) |  [Romanian / română](wiki/translations/ro/Main_Page.md) |  [Japanese / 日本語](wiki/translations/ja/Main_Page.md) |
|  [Chinese (China) / 简体中文](wiki/translations/zh-cn/Main_Page.md) |  [Polish / polski](wiki/translations/pl/Main_Page.md) |  [Spanish / español de España](wiki/translations/es/Main_Page.md) |
|  [French / français](wiki/translations/fr/Main_Page.md) |  [Chinese / 简体中文](wiki/translations/zh/Main_Page.md) |  [Italian / italiano](wiki/translations/it/Main_Page.md) |
|  [Swedish / svenska](wiki/translations/sv/Main_Page.md) |  [German / Deutsch](wiki/translations/de/Main_Page.md) |  [Chinese (Taiwan) / 繁體中文](wiki/translations/zh-tw/Main_Page.md) |
|  [Russian / русский](wiki/translations/ru/Main_Page.md) |  [Portuguese (Brazil) / português](wiki/translations/pt-br/Main_Page.md)
## Other interesting resources
* [Help FreeCAD](wiki/Help_FreeCAD.md): How to contribute to the project?
* [Donation](wiki/Donate.md) options
* FreeCAD participates to the [Google Summer of Code](wiki/Google_Summer_of_Code.md) since 2016. Learn how to participate
* All the development communication happens on the [forum](http://forum.freecadweb.org), so be sure to visit it if you are interested in participating.