mirror of
https://git.dev.opencascade.org/repos/occt.git
synced 2025-04-03 17:56:21 +03:00
e5bd0d984c
unrelated changes: Unused unit OpenCL removed from UDLIST All articles revised README revised comments are allowed in FILES.txt Add gendoc.sh for Linux Added option -s to set search engine of the HTML documents Added 3rdparty_building docs for different platforms help message removed from bat&sh scripts (left within tcl script) tableofcontents added for all huge articles; gendoc.bat doesn't change PATH variable jpgs converted to pngs and unused pngs removed logo displaying of pdf files fixed Automatic detection of OCCT version number added to occtdoc.tcl OCCT version within pdfs is got from Standard_Version.hxx; copyright changed pdf generation process removes latex dir now GIF images converted to PNG in technical_overview; references fixed (incorrect reference to wok and cdl didn't touch; redundant latex option removed Tutorial moved from Overview and made top level page LICENSE.md moved from dox/overview to dox folder Section related to OCCT building refactored and simplified. WOK and CDL explicitly declared as deprecated.
81 lines
2.8 KiB
Plaintext
81 lines
2.8 KiB
Plaintext
Open CASCADE Technology
|
|
=======================
|
|
|
|
This directory contains sources of Open CASCADE Technology (OCCT), a collection
|
|
of C++ libraries providing services for 3D surface and solid modeling, CAD data
|
|
exchange, and visualization. OCCT can be best applied in development of
|
|
software dealing with 3D modeling (CAD), manufacturing / measuring (CAM) or
|
|
numerical simulation (CAE).
|
|
|
|
License
|
|
-------
|
|
|
|
The OCCT code is subject to the Open CASCADE Technology Public License
|
|
(the "License"). You may not use the content of the relevant files except
|
|
in compliance with the License. Please see the LICENSE file or obtain a copy
|
|
of the License at http://www.opencascade.org and read it completely before
|
|
using this software.
|
|
|
|
Packaging
|
|
---------
|
|
|
|
You can receive certified version of OCCT code in different packages.
|
|
|
|
- Snapshot of Git repository: contains only bare sources of OCCT; many C++
|
|
files, HTML documentation, and project files / makefiles for building OCCT
|
|
need to be generated.
|
|
|
|
- Complete source archive: contains all sources of OCCT, including C++ files
|
|
generated by WOK, HTML and PDF documentation, and projects / makefiles for
|
|
building on all officially supported platforms.
|
|
|
|
- Binary package (platform-specific): in addition to complete source archive,
|
|
includes binaries of OCCT and third-party libraries built on one platform.
|
|
This package allows using OCCT immediately after installation.
|
|
|
|
Certified versions of OCCT can be downloaded from http://www.opencascade.org
|
|
|
|
You can also find OCCT pre-installed on your system, or install it from
|
|
packages provided by a third party. Note that packaging and functionality
|
|
of such versions can be different from certified releases. Please consult
|
|
documentation accompanyog your version for details.
|
|
|
|
Documentation
|
|
-------------
|
|
|
|
Open file doc/html/index.html to browse HTML documentation.
|
|
|
|
If HTML documentation is not available in your package, you can:
|
|
|
|
- Generate it from sources.
|
|
You need to have Tcl and Doxygen 1.8.4 (or above) in PATH.
|
|
In Tcl prompt, cd to OCCT root folder and run "source dox/start.tcl".
|
|
On Windows you can also run shortcut batch file *gendoc.bat*.
|
|
|
|
- Read documentation in source plain text (MarkDown) format found in
|
|
subfolder *dox*
|
|
|
|
See *dox/dev_guides/documentation/documentation.md* for details.
|
|
|
|
Building
|
|
--------
|
|
|
|
In most cases you need to rebuild OCCT on your platform (OS, compiler) before
|
|
using it in your project, to ensure binary compatibility.
|
|
|
|
Consult the file *dox/dev_guides/building/building.md* for instructions on
|
|
building OCCT from sources on supported platforms.
|
|
|
|
Version
|
|
-------
|
|
|
|
The current version of OCCT can be consulted in the file
|
|
*src/Standard/Standard_Version.hxx*
|
|
|
|
Development
|
|
-----------
|
|
|
|
For information regarding OCCT code development please consult the official
|
|
OCCT Collaborative Development Portal:
|
|
http://dev.opencascade.org
|