mirror of
https://git.dev.opencascade.org/repos/occt.git
synced 2025-04-02 17:46:22 +03:00
Documentation - Update the main ReadMe #81
ReadMe was moved to markdown format. Updated a links to the resources
This commit is contained in:
dpasukhi
parent
b0922ff9a1
commit
aa7c38d60e
63
README.md
Normal file
63
README.md
Normal file
@ -0,0 +1,63 @@
|
||||
# Open CASCADE Technology
|
||||
|
||||
Open CASCADE Technology (OCCT) is a software development platform providing services for 3D surface and solid modeling, CAD data exchange, and visualization. Most of OCCT functionality is available in the form of C++ libraries. OCCT is ideal for developing software dealing with 3D modeling (CAD), manufacturing/measuring (CAM), or numerical simulation (CAE).
|
||||
|
||||
## License
|
||||
|
||||
Open CASCADE Technology is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License version 2.1 as published by the Free Software Foundation, with a special exception defined in the file `OCCT_LGPL_EXCEPTION.txt`. Consult the file `LICENSE_LGPL_21.txt` included in the OCCT distribution for the complete text of the license.
|
||||
|
||||
Alternatively, Open CASCADE Technology may be used under the terms of the Open CASCADE commercial license or a contractual agreement.
|
||||
|
||||
**Note:** Open CASCADE Technology is provided on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND. The entire risk related to any use of the OCCT code and materials is on you. See the license text for a formal disclaimer.
|
||||
|
||||
## Packaging
|
||||
|
||||
You can receive certified versions of OCCT code in different packages:
|
||||
|
||||
- **Snapshot of Git repository:** Contains C++ header and source files of OCCT, documentation sources, build scripts, and CMake project files.
|
||||
- **Complete source archive:** Contains all sources of OCCT, generated HTML and PDF documentation, and ready-to-use projects for building on all officially supported platforms.
|
||||
- **Binary package (platform-specific):** In addition to the complete source archive, it 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:
|
||||
- [Open CASCADE Releases](https://dev.opencascade.org/release)
|
||||
- [GitHub Releases](https://github.com/Open-Cascade-SAS/OCCT/releases)
|
||||
|
||||
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 the documentation accompanying your version for details.
|
||||
|
||||
## Documentation
|
||||
|
||||
Documentation is available at the following links:
|
||||
- [Latest version](https://dev.opencascade.org/doc/overview)
|
||||
- [Version 7.7](https://dev.opencascade.org/doc/occt-7.7.0/overview)
|
||||
|
||||
Documentation can be part of the package. To preview documentation as part of the package, open the 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) installed on your system and accessible in your environment (check the environment variable PATH). Use the batch file `gendoc.bat` on Windows or the Bash script `gendoc` on Linux or OS X to (re)generate documentation.
|
||||
- **Read documentation in source plain text (Markdown) format** found in the subfolder `dox`.
|
||||
|
||||
See `dox/dev_guides/documentation/documentation.md` or [Building Documentation](https://dev.opencascade.org/doc/occt-7.7.0/overview/html/build_upgrade__building_documentation.html) 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` or [Building OCCT](https://dev.opencascade.org/doc/overview/html/build_upgrade__building_occt.html) for instructions on building OCCT from sources on supported platforms.
|
||||
|
||||
## Version
|
||||
|
||||
The current version of OCCT can be found in the file `src/Standard/Standard_Version.hxx`.
|
||||
|
||||
## Development
|
||||
|
||||
### Bug Tracker
|
||||
- [GitHub Issues](https://github.com/Open-Cascade-SAS/OCCT/issues)
|
||||
- [OCCT Tracker](https://tracker.dev.opencascade.org/)
|
||||
|
||||
For information regarding OCCT code development, please consult the official OCCT Collaborative Development Portal:
|
||||
- [OCCT Development Portal](http://dev.opencascade.org)
|
||||
|
||||
### Forum and Discussions
|
||||
- [OCCT Forums](https://dev.opencascade.org/forums)
|
||||
- [GitHub Discussions](https://github.com/Open-Cascade-SAS/OCCT/discussions)
|
||||
89
README.txt
89
README.txt
@ -1,89 +0,0 @@
|
||||
Open CASCADE Technology
|
||||
=======================
|
||||
|
||||
This directory contains sources of Open CASCADE Technology (OCCT), a software
|
||||
development platform providing services for 3D surface and solid modeling, CAD
|
||||
data exchange, and visualization. Most of OCCT functionality is available in
|
||||
the form of C++ libraries. OCCT can be best applied in development of software
|
||||
dealing with 3D modeling (CAD), manufacturing / measuring (CAM) or numerical
|
||||
simulation (CAE).
|
||||
|
||||
License
|
||||
-------
|
||||
|
||||
Open CASCADE Technology is free software; you can redistribute it and / or
|
||||
modify it under the terms of the GNU Lesser General Public version 2.1 as
|
||||
published by the Free Software Foundation, with special exception defined in
|
||||
the file OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included
|
||||
in OCCT distribution for complete text of the license.
|
||||
|
||||
Alternatively, Open CASCADE Technology may be used under the terms of Open
|
||||
CASCADE commercial license or contractual agreement.
|
||||
|
||||
Note that Open CASCADE Technology is provided on an "AS IS" basis, WITHOUT
|
||||
WARRANTY OF ANY KIND. The entire risk related to any use of the OCCT code and
|
||||
materials is on you. See the license text for formal disclaimer.
|
||||
|
||||
Packaging
|
||||
---------
|
||||
|
||||
You can receive certified version of OCCT code in different packages.
|
||||
|
||||
- Snapshot of Git repository: contains C++ header and source files of OCCT,
|
||||
documentation sources, build scripts, and CMake project files.
|
||||
|
||||
- Complete source archive: contains all sources of OCCT, generated HTML and PDF
|
||||
documentation, and ready-to-use projects for building on all officially
|
||||
supported platforms.
|
||||
|
||||
- Binary package (platform-specific): in addition to complete source archive,
|
||||
it 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.com
|
||||
|
||||
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 accompanying 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) installed on your system.
|
||||
and accessible in your environment (check environment variable PATH).
|
||||
Use batch file *gendoc.bat* on Windows or Bash script *gendoc* on Linux
|
||||
or OS X to (re)generate documentation.
|
||||
|
||||
- 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
|
||||
Loading…
x
Reference in New Issue
Block a user