0027341: Incorrect exact HLR results
[occt.git] / README.txt
1 Open CASCADE Technology
2 =======================
3
4 This directory contains sources of Open CASCADE Technology (OCCT), a software
5 development platform providing services for 3D surface and solid modeling, CAD 
6 data exchange, and visualization. Most of OCCT functionality is available in 
7 the form of C++ libraries. OCCT can be best applied in development of software 
8 dealing with 3D modeling (CAD), manufacturing / measuring (CAM) or numerical 
9 simulation (CAE).
10
11 License
12 -------
13
14 Open CASCADE Technology is free software; you can redistribute it and / or 
15 modify it under the terms of the GNU Lesser General Public version 2.1 as 
16 published by the Free Software Foundation, with special exception defined in 
17 the file OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included
18 in OCCT distribution for complete text of the license.
19
20 Alternatively, Open CASCADE Technology may be used under the terms of Open 
21 CASCADE commercial license or contractual agreement.
22
23 Note that Open CASCADE Technology is provided on an "AS IS" basis, WITHOUT 
24 WARRANTY OF ANY KIND. The entire risk related to any use of the OCCT code and 
25 materials is on you. See the license text for formal disclaimer.
26
27 Packaging
28 ---------
29
30 You can receive certified version of OCCT code in different packages.
31
32 - Snapshot of Git repository: contains C++ header and source files of OCCT,
33   documentation sources, build scripts, and CMake project files.
34
35 - Complete source archive: contains all sources of OCCT, generated HTML and PDF
36   documentation, and ready-to-use projects for building on all officially 
37   supported platforms.
38
39 - Binary package (platform-specific): in addition to complete source archive, 
40   it includes binaries of OCCT and third-party libraries built on one platform. 
41   This package allows using OCCT immediately after installation.
42
43 Certified versions of OCCT can be downloaded from http://www.opencascade.com
44
45 You can also find OCCT pre-installed on your system, or install it from 
46 packages provided by a third party. Note that packaging and functionality
47 of such versions can be different from certified releases. Please consult 
48 documentation accompanying your version for details.
49
50 Documentation
51 -------------
52
53 Open file doc/html/index.html to browse HTML documentation.
54
55 If HTML documentation is not available in your package, you can:
56
57 - Generate it from sources. 
58
59   You need to have Tcl and Doxygen 1.8.4 (or above) installed on your system.
60   and accessible in your environment (check environment variable PATH).
61   Use batch file *gendoc.bat* on Windows or Bash script *gendoc* on Linux
62   or OS X to (re)generate documentation.
63
64 - Read documentation in source plain text (MarkDown) format found in 
65   subfolder *dox*
66
67 See *dox/dev_guides/documentation/documentation.md* for details.
68
69 Building
70 --------
71
72 In most cases you need to rebuild OCCT on your platform (OS, compiler) before
73 using it in your project, to ensure binary compatibility.
74
75 Consult the file *dox/dev_guides/building/building.md* for instructions on
76 building OCCT from sources on supported platforms.
77
78 Version
79 -------
80
81 The current version of OCCT can be consulted in the file
82 *src/Standard/Standard_Version.hxx*
83
84 Development
85 -----------
86
87 For information regarding OCCT code development please consult the official 
88 OCCT Collaborative Development Portal:
89 http://dev.opencascade.org