Name Date Size

..18-Aug.-20214 KiB

.arcconfigH A D02-Sep.-201953

.circleci/H02-Sep.-20194 KiB

.gitattributesH A D02-Sep.-2019621

.github/H11-May-20214 KiB

.gitignoreH A D14-Apr.-2021474

.log_errorsH A D02-Sep.-201928

.travis/H02-Sep.-20194 KiB

.travis.ymlH A D27-Mar.-202116.8 KiB

appveyor.ymlH A D02-Sep.-20191.9 KiB

BUILD_OSX.mdH A D20-Sep.-202115.1 KiB

build_unix_dev_conda.shH A D27-Sep.-20202.5 KiB

ChangeLog.txtH A D02-Sep.-201951.3 KiB

ci/H21-Sep.-20214 KiB

cMake/H10-Mar.-20214 KiB

CMakeLists.txtH A D01-Apr.-20212.8 KiB

CODE_OF_CONDUCT.mdH A D02-Sep.-20193.9 KiB

conda/H23-Aug.-20214 KiB

config.h.cmakeH A D02-Sep.-20194.3 KiB

data/H02-Sep.-20194 KiB

environment-linux.ymlH A D03-Sep.-2020837

environment-osx.ymlH A D03-Sep.-2020859

lgtm.ymlH A D24-Mar.-20212.2 KiB

LibraryVersions.h.cmakeH A D06-Mar.-20211.4 KiB

LICENSEH A D02-Sep.-201925.2 KiB

package/H06-Mar.-20204 KiB

README.mdH A D12-May-20215.9 KiB

requirements.txtH A D01-Oct.-2020161

SMESH_Version.h.cmakeH A D02-Sep.-2019370

src/H14-Sep.-20214 KiB

tools/build/H01-Aug.-20214 KiB

vagrant/H14-Apr.-20214 KiB

README.md

1![Logo](https://www.freecadweb.org/images/logo.png)
2
3### Your own 3D parametric modeler
4
5[Website](https://www.freecadweb.org) • 
6[Documentation](https://wiki.freecadweb.org) •
7[Forum](https://forum.freecadweb.org/) •
8[Bug tracker](https://www.freecadweb.org/tracker/) •
9[Git repository](https://github.com/FreeCAD/FreeCAD)
10
11
12[![Release](https://img.shields.io/github/release/freecad/freecad.svg)](https://github.com/freecad/freecad/releases/latest) [![Master][freecad-master-status]][travis-branches] [![Crowdin](https://d322cqt584bo4o.cloudfront.net/freecad/localized.svg)](https://crowdin.com/project/freecad) [![Gitter](https://img.shields.io/gitter/room/freecad/freecad.svg)](https://gitter.im/freecad/freecad?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) [![Language grade: Python](https://img.shields.io/lgtm/grade/python/g/FreeCAD/FreeCAD.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/FreeCAD/FreeCAD/context:python) [![Language grade: C/C++](https://img.shields.io/lgtm/grade/cpp/g/FreeCAD/FreeCAD.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/FreeCAD/FreeCAD/context:cpp) [![Liberapay](https://img.shields.io/liberapay/receives/FreeCAD.svg?logo=liberapay)](https://liberapay.com/FreeCAD)
13
14![screenshot](https://wiki.freecadweb.org/images/thumb/7/72/Freecad016_screenshot1.jpg/800px-Freecad016_screenshot1.jpg)
15
16Overview
17--------
18
19* **Freedom to build what you want**  FreeCAD is an open-source parametric 3D 
20modeler made primarily to design real-life objects of any size. 
21Parametric modeling allows you to easily modify your design by going back into 
22your model history to change its parameters. 
23
24* **Create 3D from 2D and back** FreeCAD lets you to sketch geometry constrained
25 2D shapes and use them as a base to build other objects. 
26 It contains many components to adjust dimensions or extract design details from 
27 3D models to create high quality production-ready drawings.
28
29* **Designed for your needs** FreeCAD is designed to fit a wide range of uses
30including product design, mechanical engineering and architecture,
31whether you are a hobbyist, programmer, experienced CAD user, student or teacher.
32
33* **Cross platform** FreeCAD runs on Windows, macOS and Linux operating systems.
34
35* **Underlying technology**
36    * **OpenCASCADE** A powerful geometry kernel, the most important component of FreeCAD
37    * **Coin3D library** Open Inventor-compliant 3D scene representation model
38    * **Python** FreeCAD offers a broad Python API
39    * **Qt** Graphical user interface built with Qt
40
41
42Installing
43----------
44
45Precompiled (installable) packages are available for Windows and macOS on the
46[Releases page](https://github.com/FreeCAD/FreeCAD/releases).
47
48On most Linux distributions, FreeCAD is directly installable from the 
49software center application.
50
51Other options are described at the [wiki Download page](https://wiki.freecadweb.org/Download).
52
53Build Status
54------------
55
56| Master | 0.19 | Translation |
57|:------:|:----:|:-----------:|
58|[![Master][freecad-master-status]][travis-branches]|[![0.19][freecad-0.19-status]][travis-branches]|[![Crowdin](https://d322cqt584bo4o.cloudfront.net/freecad/localized.svg)](https://crowdin.com/project/freecad)|
59
60[freecad-0.19-status]: https://travis-ci.org/FreeCAD/FreeCAD.svg?branch=releases/FreeCAD-0-19
61[freecad-master-status]: https://travis-ci.org/FreeCAD/FreeCAD.svg?branch=master
62[travis-branches]: https://travis-ci.org/FreeCAD/FreeCAD/branches
63[travis-builds]: https://travis-ci.org/FreeCAD/FreeCAD/builds
64
65Compiling
66---------
67
68Compiling FreeCAD requires installation of several libraries and their 
69development files such as OCCT (Open Cascade), Coin and Qt, listed in the 
70pages below. Once this is done, FreeCAD can be compiled with 
71CMake. On Windows, these libraries are bundled and offered by the 
72FreeCAD team in a convenient package. On Linux, they are usually found 
73in your distribution's repositories, and on macOS and other platforms, 
74you will usually have to compile them yourself.
75
76The pages below contain up-to-date build instructions:
77
78- [Linux](https://wiki.freecadweb.org/Compile_on_Linux)
79- [Windows](https://wiki.freecadweb.org/Compile_on_Windows)
80- [macOS](https://wiki.freecadweb.org/Compile_on_MacOS)
81- [Cygwin](https://wiki.freecadweb.org/Compile_on_Cygwin)
82- [MinGW](https://wiki.freecadweb.org/Compile_on_MinGW)
83
84
85Reporting Issues
86---------
87
88To report an issue please:
89- First post to forum to verify the issue; 
90- Link forum thread to bug tracker ticket and vice-a-versa; 
91- Use the most updated stable or development versions of FreeCAD; 
92- Post version info from eg. `Help > About FreeCAD > Copy to clipboard`; 
93- Post a Step-By-Step explanation on how to recreate the issue; 
94- Upload an example file to demonstrate problem. 
95
96For more detail see:
97- [Wiki Page about the Bug Tracker](https://wiki.freecadweb.org/Tracker)
98- [Bug Tracker](https://tracker.freecadweb.org)
99- [Help Forum](http://forum.freecadweb.org/viewforum.php?f=3)
100
101
102Usage & Getting help
103--------------------
104
105The FreeCAD wiki contains documentation on 
106general FreeCAD usage, Python scripting, and development. These 
107pages might help you get started:
108
109- [Getting started](https://wiki.freecadweb.org/Getting_started)
110- [Features list](https://wiki.freecadweb.org/Feature_list)
111- [Frequent questions](https://wiki.freecadweb.org/FAQ/en)
112- [Workbenches](https://wiki.freecadweb.org/Workbenches)
113- [Scripting](https://wiki.freecadweb.org/Power_users_hub)
114- [Development](https://wiki.freecadweb.org/Developer_hub)
115
116The [FreeCAD forum](https://forum.freecadweb.org) is also a great place
117to find help and solve specific problems you might encounter when
118learning to use FreeCAD.
119
120
121<p>This project receives generous infrastructure support from
122  <a href="https://www.digitalocean.com/">
123    <img src="https://opensource.nyc3.cdn.digitaloceanspaces.com/attribution/assets/SVG/DO_Logo_horizontal_blue.svg" width="91px">
124  </a> and <a href="https://www.kipro-pcb.com/">KiCad Services Corp.</a>
125</p>
126