0024326: Get rid of confusing extension line
[occt.git] / README
diff --git a/README b/README
index 0f84738..66dc267 100644 (file)
--- a/README
+++ b/README
@@ -1,5 +1,5 @@
-               Open CASCADE Technology source repository
-               -----------------------------------------
+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
 
 This directory contains sources of Open CASCADE Technology (OCCT), a collection
 of C++ libraries providing services for 3D surface and solid modeling, CAD data
@@ -7,38 +7,74 @@ exchange, and visualization. OCCT can be best applied in development of
 software dealing with 3D modeling (CAD), manufacturing / measuring (CAM) or
 numerical simulation (CAE).
 
 software dealing with 3D modeling (CAD), manufacturing / measuring (CAM) or
 numerical simulation (CAE).
 
-The OCCT code is subject to the Open CASCADE Technology Public License Version
-6.5 (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.
+License
+-------
 
 
-In order to build OCCT libraries from these sources for use in your program, 
-you need to:
+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.
 
 
-1. Download, build, and install the required third-party libraries.
+Packaging
+---------
 
 
-   Follow the instructions provided in the documents titled "Building 3rd party
-   products for OCCT" on http://dev.opencascade.org/?q=home/resources for
-   installation and building.
+You can receive certified version of OCCT code in different packages.
 
 
-2. Install and configure WOK development environment.
+- 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.
 
 
-   See http://dev.opencascade.org/?q=home/resources for the latest build of the 
-   WOK and instructions of configuring it.
+- 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.
 
 
-3. Use WOK to generate build scripts or project files for your compiler,
-   then build the libraries.
+- 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.
 
 
-Note that you may use also the pre-processed source packages that include
-makefiles and projects, or binary packages, available for official releases of
-OCCT at http://www.opencascade.org. In this case however you will not be able
-to re-generate derived files after changing the CDL files (requires WOK).
+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
 
 The current version of OCCT can be consulted in the file
-src/Standard/Standard_Version.hxx
+*src/Standard/Standard_Version.hxx*
 
 
-For more information regarding OCCT code development please consult the official
-OCCT Collaborative Development Portal:
+Development
+-----------
 
 
-                        http://dev.opencascade.org
+For information regarding OCCT code development please consult the official 
+OCCT Collaborative Development Portal:
+http://dev.opencascade.org