Main Page

From FreeCAD Documentation
Revision as of 08:18, 19 February 2014 by Renatorivo (Talk | contribs)

Jump to: navigation, search

This is the documentation wiki of FreeCAD. The information contained here is what forms the offline documentation shipped with FreeCAD itself. 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 help!


User hubs

Below are the three main entry points to the documentation, for the three broad categories of FreeCAD users:

  • Crystal Clear app display.png Users hub: For normal users, explains how to install and use the FreeCAD application and the contents of the different workbenches
  • Crystal Clear app terminal.png Power users hub: For advanced users, explains how to use macros and python scripting to enhance your workflow
  • Crystal Clear app tutorials.png Developers hub: For developers, explains how to write code for the FreeCAD application, extend it or use it in your own applications

Manual

The FreeCAD manual is another, more linear way to present the articles contained in this wiki. It forms 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. 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, helping newcomers, translating the application and documentation, help packaging the latest release of FreeCAD for your favourite operating system, or simply help other people to discover FreeCAD around you. The help FreeCAD page describes it all with more details.

Source code

FreeCAD can be compiled using cMake or autotools, the git link is git://free-cad.git.sourceforge.net/gitroot/free-cad/free-cad and there are build instructions for Windows, Unix/Linux and MacOSX.

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


Other languages:Czech 100% • ‎German 100% • ‎English 100% • ‎Spanish 100% • ‎French 100% • ‎Italian 100% • ‎Japanese 14% • ‎Polish 100% • ‎Portuguese 100% • ‎Brazilian Portuguese 100% • ‎Russian 57% • ‎Swedish 64% • ‎Turkish 57% • ‎Chinese 14%
Personal tools
Namespaces

Variants
Actions
Users documentation
Powerusers documentation
Developers documentation
Help & Feedback
Meta
Toolbox