0024514: Unclear guidelines to report issues in Mantis
[occt.git] / dox / dev_guides / dev_guides.md
index 5e88b4f..f99855e 100644 (file)
@@ -1,79 +1,16 @@
  Developer Guides {#dev_guides}
 ================
 
-## Source Repository
+The following documents provide information on OCCT building, development and testing:
 
-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).
+* @subpage occt_dev_guides__building "Building OCCT from sources"
+* @subpage occt_dev_guides__documentation "Documentation system"
+* @subpage occt_dev_guides__coding_rules "Coding Rules"
+* @subpage occt_dev_guides__contribution_workflow "Contribution Workflow"
+* @subpage occt_dev_guides__git_guide "Guide to installing and using Git for OCCT development"
+* @subpage occt_dev_guides__tests "Automatic Testing system"
+* @subpage occt_dev_guides__debug "Debugging tools and hints"
 
-The OCCT code is subject to the Open CASCADE Technology Public License Version
-6.6 (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.
+The following guide provides information relevant to upgrading applications developed with previous versions of OCCT, to recent one:
 
-## Automatic tests
-
-OCCT automatic testing system is integrated with @ref draw "DRAW Test Harness",
-a console application based on Tcl (a scripting language).
-All tests are run from DRAW command prompt (run **draw.bat** or 
-**draw.sh** to start it).
-
-Standard OCCT tests are located in subdirectory **tests** of the OCCT root 
-folder. This location is set as default at DRAW start (see environment variable 
-_CSF_TestScriptsPath_ defined in **src/DrawResources/DrawDefaults**).
-
-The tests are organized in three levels:
-- Group: a group of related test grids, usually testing a particular subset of OCCT functionality (e.g. *blend*). 
-- Grid: a set of test cases within a group, usually aimed at testing a particular aspect or mode of execution of the relevant functionality (e.g. *buildevol*).
-- Test case: a script implementing an individual test (e.g. *K4*).
-
-To run all tests, type command *testgrid*:
-
-    Draw[]\> testgrid
-
-For running only a group or a grid of tests, give additional arguments indicating the group and (if needed) the grid name:
-
-    Draw[]\> testgrid blend simple
-
-As the tests progress, the result of each test case is reported. 
-At the end of the log a summary of test cases is output, including the list of 
-detected regressions and improvements, if any.
-The tests are considered as non-regressive if only OK, BAD (i.e. known problem), 
-and SKIPPED (i.e. not executed, typically because of lack of a data file) 
-statuses are reported. 
-
-To run a single test, type command 'test' followed by the names of 
-group, grid, and test case. 
-
-    Draw[1]\> test blend simple A1
-    CASE blend simple A1: OK
-
-To see intermediate commands and their output during the test execution, 
-add one more argument '-echo' at the end of the command line, or type 'dlog get'
-after test completion. 
-
-For more information consult \subpage dev_guides__tests
-
-## docs
-**short description**
-
-\subpage dev_guides__documentation
-
-## wok
-**short description**
-
-\subpage dev_guides__wok
-
-## building
-**short description**
-
-\subpage dev_guides__building
-
-## cdl
-**short description**
-
-\subpage dev_guides__cdl
\ No newline at end of file
+* @subpage occt_dev_guides__upgrade "Upgrade from previous OCCT versions"