File	Date	Author	Commit
cMake	2014-02-10	wmayer	[006083] + undo changes of 8b610aff on issue 0001375 bec...
data	2014-01-21	wmayer	[303614] + Copy shiboken files from LibPack
package	2014-02-01	wmayer	[15406d] fixes #0001378: outdated url in man pages
src	14 hours ago	wmayer	[f80419] + Avoid cyclic dependency of tree items
.gitattributes	2014-01-17	wmayer	[0cbbfe] + Shared library of Mefisto2F
.gitignore	2014-03-04	jriegel	[c5193b] more ignor for Windows platform
BuildAll.bat	2011-10-10	wmayer	[120ca8] + unify DLL export defines to namespace names
BuildRelease.ini	2011-10-10	wmayer	[120ca8] + unify DLL export defines to namespace names
BuildRelease.py	2011-10-10	wmayer	[120ca8] + unify DLL export defines to namespace names
CMakeLists.txt	2014-03-01	jriegel	[93f992] remove /EHa from Windows DEBUG builds
ChangeLog.txt	2013-04-26	wmayer	[06df5d] Fix typo
Makefile.am	2011-10-25	wmayer	[36d392] + fix Makefiles
README	2013-11-11	Yorik van Havre	[782cae] Updated forum links to the new subdomain
README.Cygwin	2011-10-10	wmayer	[120ca8] + unify DLL export defines to namespace names
README.Linux	2011-10-10	wmayer	[120ca8] + unify DLL export defines to namespace names
README.MinGW	2014-01-09	Yorik van Havre	[fbc672] Added pySide info to MingW readme
README.Win32	2014-01-17	wmayer	[0cbbfe] + Shared library of Mefisto2F
acinclude.m4	2012-10-28	wmayer	[60e09f] Fixes for MacOSX
autogen.sh	2012-12-08	wmayer	[d838f4] Make automake distcheck ready
build.sh	2011-10-10	wmayer	[120ca8] + unify DLL export defines to namespace names
config.h.cmake	2011-10-10	wmayer	[120ca8] + unify DLL export defines to namespace names
configure.ac	2012-11-18	Jose Luis Cercos Pita	[b1a362] Removed surfaces module (simply broken and outd...
copying.lib	2012-07-05	wmayer	[90a7f6] Fix address of FSF in copyright notice
mkinstalldirs	2011-10-10	wmayer	[120ca8] + unify DLL export defines to namespace names

Read Me

FreeCAD
=======

FreeCAD is a general purpose feature-based, parametric 3D modeler for CAD, MCAD,
CAx, CAE and PLM, aimed directly at mechanical engineering and product design but
also fits a wider range of uses in engineering, such as architecture or other engineering
specialties. It is 100% Open Source (LGPL2+ license) and extremely modular, allowing
for very advanced extension and customization.

FreeCAD is based on OpenCasCade, a powerful geometry kernel, features an Open Inventor-compliant
3D scene representation model provided by the Coin 3D library, and a broad Python API.
The interface is built with Qt. FreeCAD runs exactly the same way on Windows, Mac OSX, BSD and
Linux platforms.

Home page:                             http://www.freecadweb.org
Documentation wiki:                    http://www.freecadweb.org/wiki/
Forum:                                 http://forum.freecadweb.org/
Bug tracker:                           http://www.freecadweb.org/tracker/
Git repository:                        http://sourceforge.net/p/free-cad/code/ci/master/tree/

Installing
==========

Precompiled (installable) packages are usually available to you from several sources and are
described on the FreeCAD download page: http://www.freecadweb.org/wiki/index.php?title=Download

Compiling
=========

Compiling FreeCAD requires to install several heavyweight libraries and their development
files such as OpenCasCADe, Coin and Qt, listed in the pages below. Once this is done,
FreeCAD can be simply compiled with cMake. On windows, these libraries are bundled and
offeredby the FreeCAD team in a convenience package, on Linux they are usually found
in your distribution's repositories and on Mac OSX and other platforms you will usually
need to compile them yourself.

Note that autotools build system can still be used but will be obsoleted soon.

The pages below contain up-to-date build instructions:

For Linux:   http://www.freecadweb.org/wiki/index.php?title=CompileOnUnix
For windows: http://www.freecadweb.org/wiki/index.php?title=CompileOnWindows
For Mac OSX: http://www.freecadweb.org/wiki/index.php?title=CompileOnMac

In this folder you will also find additional README files, specific for each platform.

Usage
=====

The FreeCAD documentation wiki contains sections for each category of users, and a manual,
which is a compilation of the most useful articles of the wiki:

For users: General FreeCAD usage: http://www.freecadweb.org/wiki/index.php?title=User_hub
For power-users: Python scripting: http://www.freecadweb.org/wiki/index.php?title=Power_users_hub
For developers: C++ FreeCAD development: http://www.freecadweb.org/wiki/index.php?title=Developer_hub

The FreeCAD manual: http://www.freecadweb.org/wiki/index.php?title=Online_Help_Toc