X-Git-Url: http://git.dev.opencascade.org/gitweb/?p=occt.git;a=blobdiff_plain;f=README.txt;h=c8aec1cd248702e5edfc1800ff49c6c4ca383a9c;hp=e2800c8e71ac51081baa3ea4d94a15cbb76d9d95;hb=9d1bf7ae0556aeee9b7a26d8f8f9baa297695ccc;hpb=47d9074abb0e4d98cde41c8648a98d3bc2af240e diff --git a/README.txt b/README.txt index e2800c8e71..c8aec1cd24 100644 --- a/README.txt +++ b/README.txt @@ -29,24 +29,23 @@ 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. +- 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, including C++ files - generated by WOK, HTML and PDF documentation, and projects / makefiles for - building on all officially supported platforms. +- 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.org +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 accompanyog your version for details. +documentation accompanying your version for details. Documentation ------------- @@ -59,8 +58,8 @@ If HTML documentation is not available in your package, you can: 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). - Run batch file *gendoc.bat* on Windows or Bash scriot *gendoc.sh* on Linux - or Mac OS X to (re)generate documentation. + 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*