| e5bd0d98 |
1 | Open CASCADE Technology |
| 2 | ======================= |
| 6bf8a464 |
3 | |
| 4 | This directory contains sources of Open CASCADE Technology (OCCT), a collection |
| 5 | of C++ libraries providing services for 3D surface and solid modeling, CAD data |
| 6 | exchange, and visualization. OCCT can be best applied in development of |
| 7 | software dealing with 3D modeling (CAD), manufacturing / measuring (CAM) or |
| 8 | numerical simulation (CAE). |
| 9 | |
| e5bd0d98 |
10 | License |
| 11 | ------- |
| 6bf8a464 |
12 | |
| e5bd0d98 |
13 | The OCCT code is subject to the Open CASCADE Technology Public License |
| 14 | (the "License"). You may not use the content of the relevant files except |
| 15 | in compliance with the License. Please see the LICENSE file or obtain a copy |
| 16 | of the License at http://www.opencascade.org and read it completely before |
| 17 | using this software. |
| 6bf8a464 |
18 | |
| e5bd0d98 |
19 | Packaging |
| 20 | --------- |
| 6bf8a464 |
21 | |
| e5bd0d98 |
22 | You can receive certified version of OCCT code in different packages. |
| 6bf8a464 |
23 | |
| e5bd0d98 |
24 | - Snapshot of Git repository: contains only bare sources of OCCT; many C++ |
| 25 | files, HTML documentation, and project files / makefiles for building OCCT |
| 26 | need to be generated. |
| 6bf8a464 |
27 | |
| e5bd0d98 |
28 | - Complete source archive: contains all sources of OCCT, including C++ files |
| 29 | generated by WOK, HTML and PDF documentation, and projects / makefiles for |
| 30 | building on all officially supported platforms. |
| 6bf8a464 |
31 | |
| e5bd0d98 |
32 | - Binary package (platform-specific): in addition to complete source archive, |
| 33 | includes binaries of OCCT and third-party libraries built on one platform. |
| 34 | This package allows using OCCT immediately after installation. |
| 6bf8a464 |
35 | |
| e5bd0d98 |
36 | Certified versions of OCCT can be downloaded from http://www.opencascade.org |
| 37 | |
| 38 | You can also find OCCT pre-installed on your system, or install it from |
| 39 | packages provided by a third party. Note that packaging and functionality |
| 40 | of such versions can be different from certified releases. Please consult |
| 41 | documentation accompanyog your version for details. |
| 42 | |
| 43 | Documentation |
| 44 | ------------- |
| 45 | |
| 46 | Open file doc/html/index.html to browse HTML documentation. |
| 47 | |
| 48 | If HTML documentation is not available in your package, you can: |
| 49 | |
| 50 | - Generate it from sources. |
| 51 | You need to have Tcl and Doxygen 1.8.4 (or above) in PATH. |
| 52 | In Tcl prompt, cd to OCCT root folder and run "source dox/start.tcl". |
| 53 | On Windows you can also run shortcut batch file *gendoc.bat*. |
| 54 | |
| 55 | - Read documentation in source plain text (MarkDown) format found in |
| 56 | subfolder *dox* |
| 57 | |
| 58 | See *dox/dev_guides/documentation/documentation.md* for details. |
| 59 | |
| 60 | Building |
| 61 | -------- |
| 62 | |
| 63 | In most cases you need to rebuild OCCT on your platform (OS, compiler) before |
| 64 | using it in your project, to ensure binary compatibility. |
| 65 | |
| 66 | Consult the file *dox/dev_guides/building/building.md* for instructions on |
| 67 | building OCCT from sources on supported platforms. |
| 68 | |
| 69 | Version |
| 70 | ------- |
| 6bf8a464 |
71 | |
| 72 | The current version of OCCT can be consulted in the file |
| e5bd0d98 |
73 | *src/Standard/Standard_Version.hxx* |
| 6bf8a464 |
74 | |
| e5bd0d98 |
75 | Development |
| 76 | ----------- |
| 6bf8a464 |
77 | |
| e5bd0d98 |
78 | For information regarding OCCT code development please consult the official |
| 79 | OCCT Collaborative Development Portal: |
| 80 | http://dev.opencascade.org |
projects / occt.git / blame