fcf0b75c39
* Update moto in README * Updated Installation section on README * Update compiling section in README * Removed link to page * Updated Contributing section of README * Added section divider for sponsors in README * Moved underlying technology into collapsible box * Updated Overview section of README * Updated help section in README * Switch note on README * Update header in README * Revert "Update moto in README" This reverts commit a7ba483a1aa7e410bde01dd42bf5ef0c7d3d8ca8. * Revert "Updated Contributing section of README" This reverts commit 2b4a1fdb9f2cf838039c30c755179f1c1b2b0bec. * Updated overview section description * Fixed wording in overview * Restored section header line * Revert "Updated Overview section of README" This reverts commit accff3fdb9cefde9b691fa654512903877140cab. * Partial revert of 52d9c8a * Revert "Moved underlying technology into collapsible box" This reverts commit d1cc1ae87b8eee5702611ecb50c0067c50ae05c6. * Added newlines to compiling section
121 lines
5.4 KiB
Markdown
121 lines
5.4 KiB
Markdown
<a href="https://freecad.org"><img src="/src/Gui/Icons/freecad.svg" height="100px" width="100px"></a>
|
|
|
|
### Your own 3D parametric modeler
|
|
|
|
[Website](https://www.freecad.org) •
|
|
[Documentation](https://wiki.freecad.org) •
|
|
[Forum](https://forum.freecad.org/) •
|
|
[Bug tracker](https://github.com/FreeCAD/FreeCAD/issues) •
|
|
[Git repository](https://github.com/FreeCAD/FreeCAD) •
|
|
[Blog](https://blog.freecad.org)
|
|
|
|
|
|
[](https://github.com/freecad/freecad/releases/latest) [](https://crowdin.com/project/freecad) [](https://liberapay.com/FreeCAD)
|
|
|
|
<img src="/.github/images/partdesign.png" width="800"/>
|
|
|
|
Overview
|
|
--------
|
|
|
|
* **Freedom to build what you want** FreeCAD is an open-source parametric 3D
|
|
modeler made primarily to design real-life objects of any size.
|
|
Parametric modeling allows you to easily modify your design by going back into
|
|
your model history to change its parameters.
|
|
|
|
* **Create 3D from 2D and back** FreeCAD lets you to sketch geometry constrained
|
|
2D shapes and use them as a base to build other objects.
|
|
It contains many components to adjust dimensions or extract design details from
|
|
3D models to create high quality production-ready drawings.
|
|
|
|
* **Designed for your needs** FreeCAD is designed to fit a wide range of uses
|
|
including product design, mechanical engineering and architecture,
|
|
whether you are a hobbyist, programmer, experienced CAD user, student or teacher.
|
|
|
|
* **Cross platform** FreeCAD runs on Windows, macOS and Linux operating systems.
|
|
|
|
* **Underlying technology**
|
|
* **OpenCASCADE** A powerful geometry kernel, the most important component of FreeCAD
|
|
* **Coin3D library** Open Inventor-compliant 3D scene representation model
|
|
* **Python** FreeCAD offers a broad Python API
|
|
* **Qt** Graphical user interface built with Qt
|
|
|
|
|
|
Installing
|
|
----------
|
|
|
|
Precompiled packages for stable releases are available for Windows, macOS and Linux on the
|
|
[Releases page](https://github.com/FreeCAD/FreeCAD/releases).
|
|
|
|
On most Linux distributions, FreeCAD is also directly installable from the
|
|
software center application.
|
|
|
|
For development releases visit the [weekly-builds page](https://github.com/FreeCAD/FreeCAD-Bundle/releases/tag/weekly-builds).
|
|
|
|
Other options are described on the [wiki Download page](https://wiki.freecad.org/Download).
|
|
|
|
Compiling
|
|
---------
|
|
|
|
FreeCAD requires several dependencies to correctly compile for development and
|
|
production builds. The following pages contain updated build instructions for
|
|
their respective platforms:
|
|
|
|
- [Linux](https://wiki.freecad.org/Compile_on_Linux)
|
|
- [Windows](https://wiki.freecad.org/Compile_on_Windows)
|
|
- [macOS](https://wiki.freecad.org/Compile_on_MacOS)
|
|
- [MinGW](https://wiki.freecad.org/Compile_on_MinGW)
|
|
|
|
|
|
Reporting Issues
|
|
---------
|
|
|
|
To report an issue please:
|
|
|
|
- Consider posting to the [Forum](https://forum.freecad.org), [Discord](https://discord.com/invite/F4hdxzYZfc) channel, or [Reddit](https://www.reddit.com/r/FreeCAD) to verify the issue;
|
|
- Search the existing [issues](https://github.com/FreeCAD/FreeCAD/issues) for potential duplicates;
|
|
- Use the most updated stable or [development versions](https://github.com/FreeCAD/FreeCAD-Bundle/releases/tag/weekly-builds) of FreeCAD;
|
|
- Post version info from `Help > About FreeCAD > Copy to clipboard`;
|
|
- Restart FreeCAD in safe mode `Help > Restart in safe mode` and try to reproduce the issue again. If the issue is resolved it can be fixed by deleting the FreeCAD config files.
|
|
- Start recording a macro `Macro > Macro recording...` and repeat all steps. Stop recording after the issue occurs and upload the saved macro or copy the macro code in the issue;
|
|
- Post a Step-By-Step explanation on how to recreate the issue;
|
|
- Upload an example file (FCStd as ZIP file) to demonstrate the problem;
|
|
|
|
For more details see:
|
|
|
|
- [Bug Tracker](https://github.com/FreeCAD/FreeCAD/issues)
|
|
- [Reporting Issues and Requesting Features](https://github.com/FreeCAD/FreeCAD/issues/new/choose)
|
|
- [Contributing](https://github.com/FreeCAD/FreeCAD/blob/main/CONTRIBUTING.md)
|
|
- [Help Forum](https://forum.freecad.org/viewforum.php?f=3)
|
|
- [Developers Handbook](https://freecad.github.io/DevelopersHandbook/)
|
|
|
|
> [!NOTE]
|
|
The [FPA](https://fpa.freecad.org) offers developers the opportunity
|
|
to apply for a grant to work on projects of their choosing. Check
|
|
[jobs and funding](https://blog.freecad.org/jobs/) to know more.
|
|
|
|
|
|
Usage & Getting Help
|
|
--------------------
|
|
|
|
The FreeCAD wiki contains documentation on
|
|
general FreeCAD usage, Python scripting, and development.
|
|
View these pages for more information:
|
|
|
|
- [Getting started](https://wiki.freecad.org/Getting_started)
|
|
- [Features list](https://wiki.freecad.org/Feature_list)
|
|
- [Frequent questions](https://wiki.freecad.org/FAQ/en)
|
|
- [Workbenches](https://wiki.freecad.org/Workbenches)
|
|
- [Scripting](https://wiki.freecad.org/Power_users_hub)
|
|
- [Development](https://wiki.freecad.org/Developer_hub)
|
|
|
|
The [FreeCAD forum](https://forum.freecad.org) is a great place
|
|
to find help and solve specific problems when learning to use FreeCAD.
|
|
|
|
---
|
|
|
|
<p>This project receives generous infrastructure support from
|
|
<a href="https://www.digitalocean.com/">
|
|
<img src="https://opensource.nyc3.cdn.digitaloceanspaces.com/attribution/assets/SVG/DO_Logo_horizontal_blue.svg" width="91px">
|
|
</a> and <a href="https://www.kipro-pcb.com/">KiCad Services Corp.</a>
|
|
</p>
|