0031939: Coding - correction of spelling errors in comments [part 2]
[occt.git] / samples / qt / OCCTOverview / ReadMe.md
1 Qt OCCT Overview samples {#samples_qt_overview}
2 ==========
3
4 1. Contents
5 -----------------------
6
7 The directory <i> samples/qt/OCCTOverview </i> contains the folders and files of the Qt OCCT Overview application:
8
9 * Files **OCCTOverview.pro** and **OCCTOverview0.pro** are Qt project files.
10 * File **genproj.bat** to denerate MS Visual Studio project.
11 * File **msvc.bat**  to run MS Visual Studio project.
12 * File **make.sh** to build of the application on Linux.
13 * Files **run.bat** and **run.sh** to run the application.
14 * Files **env.bat** and **custom.bat** are called from *genproj.bat*, *msvc.bat*, *run.bat*.
15   File *custom.bat* should be defined by user to provide paths to QT directory and OCCT installation directory (see *custom.bat.template*).
16 * **src** and **res** directories provide source and resources files.
17
18 The directory <i> samples/OCCTOverview/code </i> contains the source code of samples.
19
20 2. How to build Qt OCCT Overview application
21 ---------------------------------
22
23 * Edit custom.bat file. It is necessary to define following variables:
24   * **QTDIR** path to where Qt is installed
25   * **CASROOT** path to where Open CASCADE binaries are installed.
26
27 * Build the application:
28
29     * On Windows:
30         * Generate project files: `> genproj.bat vc141 win64 Debug`
31         * Launch MS Visual Studio: `> msvc.bat vc141 win64 Debug`
32         * Build the application using MS Visual Studio.
33
34     * On Linux: Launch building of the application by make.sh script
35
36 3. Running the application
37 --------------------------
38
39 * On Windows:
40 ~~~~
41  > run.bat vc141 win64 Debug
42 ~~~~
43
44 * On Linux:
45 ~~~~
46  > run.sh
47 ~~~~
48
49 4. How to use the OCCT Overview application:
50 ---------------------------------
51
52 * To select a samples category use the *Category* menu.
53 * To run concrete sample using the menu to the right of the category menu.
54 * See the source code in the *Sample code* window. –°opy the code if needed.
55 * See the sample output in the *Output* window if it exist.
56 * Zoom, pan and rotate a geometry in the mail window using the mouse.
57
58 See hints how to use the mouse in down hints panel.