Update of title page of documentation (overview)
[occt.git] / samples / ios / UIKitSample / ReadMe.md
index 524866d..44d688c 100644 (file)
@@ -1,4 +1,11 @@
-// This file contains a description of the UIKitSample and step-by-step instructions how to build and run it.
+OCCT sample for iOS {#occt_samples_ios_uikit}
+================== 
+
+UIKitSample consists of the Open CASCADE 3D Viewer which provides import of STEP files and toolbar with three buttons.
+
+The first and second buttons serve for import hardcoded STEP files. The third button displays "About" dialog.
+
+The viewer supports zoom, pan and rotate actions. The viewer supports selection of solids as well.
 
 Installation and configuration:
     1. Make sure you are running Mac OS version 10.12.1 or above and properly installed XCode version 8.1 or above.
@@ -9,8 +16,3 @@ Installation and configuration:
     6. Select the UIKitSample and go to the "Build Settings" tab. After go to the section "Search Paths" and in the field "Header Search Paths" specify a path to the OCCT inc folder. Next in the field "Library Search Paths" specify a path/paths to the OCCT static libraries and Freetype2 static library folders.
     7. Connect device and build sample for device or choose simulator as a target and build for simulator.
     8. Run sample.
-
- Description:
-    UIKitSample consists of the Open CASCADE 3D Viewer which provides import of STEP files and toolbar with three buttons.
-    The first and second buttons serve for import hardcoded STEP files. The third button displays "About" dialog.
-    The viewer supports zoom, pan and rotate actions. The viewer supports selection of solids as well.