0024722: Move functionality of WOK command wgendoc to OCCT tool gendoc
[occt.git] / dox / dev_guides / building / building.md
1 Building OCCT from sources {#occt_dev_guides__building}
2 =========
3
4 In order to build OCCT libraries from these sources for use in your program, 
5 you need to:
6
7 1. Make sure you have all required third-party libraries installed (check 
8    software requirements in \ref OCCT_OVW_SECTION_5 "Overview").
9
10    See the following documents for short guide to installation of 
11    third-party libraries on different platforms:
12    - \subpage occt_dev_guides__building_3rdparty_windows
13    - \subpage occt_dev_guides__building_3rdparty_linux
14    - \subpage occt_dev_guides__building_3rdparty_osx
15
16 2. If you use bare OCCT sources from Git repository or made some changes affecting
17    CDL files or dependencies of OCCT toolkits, you need to update header files generated
18    from \ref occt_dev_guides__cdl "CDL", and regenerate build scripts for your environment using WOK.
19    See \subpage occt_dev_guides__building_wok for details.
20
21    Skip to step 3 if you use complete source package (e.g. official OCCT 
22    release) without changes in CDL.
23
24 3. Build using your preferred build tool.
25    - \subpage occt_dev_guides__building_automake "Building on Linux with Autotools"
26    - \subpage occt_dev_guides__building_cmake "Building with CMake (cross-platform)"
27    - \subpage occt_dev_guides__building_code_blocks "Building on Mac OS X with Code::Blocks"
28    - \subpage occt_dev_guides__building_msvc "Building on Windows with MS Visual Studio"
29    - \subpage occt_dev_guides__building_xcode "Building on Mac OS X with Xcode"
30
31 The current version of OCCT can be consulted in the file src/Standard/Standard_Version.hxx