From: abv <abv@opencascade.com>
Date: Thu, 29 Mar 2012 11:02:06 +0000 (+0400)
Subject: 0023045: Add Readme file to OCCT sources
X-Git-Tag: V6_5_3_beta1~9
X-Git-Url: http://git.dev.opencascade.org/gitweb/?p=occt.git;a=commitdiff_plain;h=6bf8a4643a97865ec89db4e3e10957edc46cbbc9

0023045: Add Readme file to OCCT sources
---

diff --git a/README b/README
new file mode 100644
index 0000000000..0f84738498
--- /dev/null
+++ b/README
@@ -0,0 +1,44 @@
+               Open CASCADE Technology source repository
+               -----------------------------------------
+
+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).
+
+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.
+
+In order to build OCCT libraries from these sources for use in your program, 
+you need to:
+
+1. Download, build, and install the required third-party libraries.
+
+   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.
+
+2. Install and configure WOK development environment.
+
+   See http://dev.opencascade.org/?q=home/resources for the latest build of the 
+   WOK and instructions of configuring it.
+
+3. Use WOK to generate build scripts or project files for your compiler,
+   then build the libraries.
+
+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).
+
+The current version of OCCT can be consulted in the file
+src/Standard/Standard_Version.hxx
+
+For more information regarding OCCT code development please consult the official
+OCCT Collaborative Development Portal:
+
+                        http://dev.opencascade.org