Skip to content

Commit f1836d6

Browse files
jhlegarretadzenanz
authored andcommitted
STYLE: Improve the README.rst file style.
Improve the `README.rst` file style, and conform to `ITKModuleTemplate` conventions: - Divide the file into sections. - Cross-reference the `LICENSE` file. - Improve the IJ citation to conform to common format.
1 parent 72b9dc1 commit f1836d6

File tree

1 file changed

+20
-4
lines changed

1 file changed

+20
-4
lines changed

README.rst

Lines changed: 20 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,20 +16,36 @@ ITKMinimalPathExtraction
1616
|CircleCI| |TravisCI| |AppVeyor|
1717
=========== =========== ===========
1818

19+
20+
Overview
21+
--------
22+
1923
This is an `ITK <http://itk.org>`_ module that implements a minimal path
2024
extraction framework based on Fast Marching arrival functions.
2125

2226
A more detailed description can be found in
2327
`the Insight Journal article <http://hdl.handle.net/1926/1332>`_::
2428

25-
Mueller, D. "Fast Marching Minimal Path Extraction in ITK"
29+
Mueller, D.
30+
"Fast Marching Minimal Path Extraction in ITK"
31+
The Insight Journal. January-June, 2008.
2632
http://hdl.handle.net/1926/1332
2733
http://www.insight-journal.org/browse/publication/213
28-
March, 2008.
2934

30-
Since ITK 4.8.0, this module is available in the ITK source tree as a Remote
31-
module. To enable it, set::
35+
36+
Installation
37+
------------
38+
39+
Since ITK 4.8.0, this module is available in the ITK source tree as a remote
40+
module. To enable it, set::
3241

3342
Module_MinimalPathExtraction:BOOL=ON
3443

3544
in ITK's CMake build configuration.
45+
46+
47+
License
48+
-------
49+
50+
This software is distributed under the Apache 2.0 license. Please see
51+
the *LICENSE* file for details.

0 commit comments

Comments
 (0)