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 only bare sources of OCCT; many C++
  33   files, HTML documentation, and project files / makefiles for building OCCT
  34   need to be generated.
  35
  36 - Complete source archive: contains all sources of OCCT, including C++ files
  37   generated by WOK, HTML and PDF documentation, and projects / makefiles for
  38   building on all officially supported platforms.
  39
  40 - Binary package (platform-specific): in addition to complete source archive,
  41   it includes binaries of OCCT and third-party libraries built on one platform.
  42   This package allows using OCCT immediately after installation.
  43
  44 Certified versions of OCCT can be downloaded from http://www.opencascade.org
  45
  46 You can also find OCCT pre-installed on your system, or install it from
  47 packages provided by a third party. Note that packaging and functionality
  48 of such versions can be different from certified releases. Please consult
  49 documentation accompanyog your version for details.
  50
  51 Documentation
  52 -------------
  53
  54 Open file doc/html/index.html to browse HTML documentation.
  55
  56 If HTML documentation is not available in your package, you can:
  57
  58 - Generate it from sources.
  59
  60   You need to have Tcl and Doxygen 1.8.4 (or above) installed on your system.
  61   and accessible in your environment (check environment variable PATH).
  62   Run batch file *gendoc.bat* on Windows or Bash scriot *gendoc.sh* on Linux
  63   or Mac OS X to (re)generate documentation.
  64
  65 - Read documentation in source plain text (MarkDown) format found in
  66   subfolder *dox*
  67
  68 See *dox/dev_guides/documentation/documentation.md* for details.
  69
  70 Building
  71 --------
  72
  73 In most cases you need to rebuild OCCT on your platform (OS, compiler) before
  74 using it in your project, to ensure binary compatibility.
  75
  76 Consult the file *dox/dev_guides/building/building.md* for instructions on
  77 building OCCT from sources on supported platforms.
  78
  79 Version
  80 -------
  81
  82 The current version of OCCT can be consulted in the file
  83 *src/Standard/Standard_Version.hxx*
  84
  85 Development
  86 -----------
  87
  88 For information regarding OCCT code development please consult the official
  89 OCCT Collaborative Development Portal:
  90 http://dev.opencascade.org