Skip to content

Commit bb8fe00

Browse files
committed
DOC: Improve the README file.
Improve the `README` file: - Improve the markup. - Remove the `CMake` specific-instructions to reduce the clutter. The ITK `WikiExamples` are no different of other examples in many ways. - Remove the pre-`Remote Module` instructions: many examples will surely require ITKv4, and may be ITK v5.
1 parent 911c1d3 commit bb8fe00

File tree

1 file changed

+12
-47
lines changed

1 file changed

+12
-47
lines changed

README.rst

Lines changed: 12 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -10,53 +10,18 @@ Overview
1010

1111
The ITK WikiExamples can be built in several ways:
1212

13-
1) A single example - go to the example page and follow instrutions
14-
2) All examples stand-alone go to
15-
http://www.vtk.org/Wiki/ITK/Examples/Instructions/ForUsers#Build_all_of_the_examples
16-
3) All examples with a superbuild that builds a proper ITK and VTK - go to
17-
http://www.vtk.org/Wiki/ITK/Examples/Instructions/ForUsers#Use_the_Superbuild_to_build_a_proper_VTK_and_ITK
18-
4) As an ITKv4 Remote Module proceed as follows.
13+
1. A single example. Follow the instrutions of the example.
14+
2. All examples stand-alone. Follow `these instructions <http://www.vtk.org/Wiki/ITK/Examples/Instructions/ForUsers#Build_all_of_the_examples>`_.
15+
3. All examples with a `Superbuild` that builds a proper ITK and VTK. Follow
16+
`these guidelines <http://www.vtk.org/Wiki/ITK/Examples/Instructions/ForUsers#Use_the_Superbuild_to_build_a_proper_VTK_and_ITK>`_.
17+
4. As an ITK `Remote` Module. Follow these guidelines:
1918

20-
* Enable fetching
21-
1) Go to: https://github.com/InsightSoftwareConsortium/ITKWikiExamples/raw/master/WikiExamples.remote.cmake
22-
2) Right click on the "Raw" button and select "Save Link As..."
23-
3) Save the file in: YOUR_ITK_SOURCE_DIR/Modules/Remote
19+
* Enable the `Module_WikiExamples` boolean variable in your ITK CMake file.
20+
* Configure and generate your ITK project.
21+
* Build the `WikiExamples` modules.
2422

25-
A) If you use an interactive cmake (ccmake, cmake-gui or cmakesetup)
26-
--------------------------------------------------------------------
27-
* Configure
28-
1) Go to your itk build directory and run cmake
29-
2) Configure
23+
If you want to test the `WikiExamples`, execute the follwoing commands::
3024

31-
* NOTE: ITK 4.4 and earlier
32-
Fetch ITK Wiki Examples
33-
1) Open the highlighted (red) cmake entry
34-
2) Check the Fetch_WikiExamples box
35-
3) Configure
36-
37-
* Enable ITK Wiki Exampes
38-
1) Configure (yes, do it again)
39-
2) Open the highlighted (red) cmake entry
40-
3) Check the Module_WikiExamples box
41-
4) Configure
42-
5) Generate
43-
6) Exit cmake
44-
45-
B) If you use cmake from the command line
46-
--------------------------------------
47-
From your itk build directory
48-
* Configure
49-
1) NOTE: ITK 4.4 and earlier
50-
cmake -DFetch_WikiExamples=ON YOUR_ITK_SOURCE_DIR
51-
2) cmake -DModule_WikiExamples=ON YOUR_ITK_SOURCE_DIR
52-
53-
Once you have configured using A) or B)
54-
---------------------------------------
55-
* Build WikiExamples
56-
From your itk build directory
57-
1) make
58-
59-
* Test WikiExamples if testing is ON
60-
1) cd your itk build directory
61-
2) cd Modules/Remote/WikiExamples
62-
3) ctest
25+
$ cd {itk_bld}
26+
$ cd Modules/Remote/WikiExamples
27+
$ ctest

0 commit comments

Comments
 (0)