STYLE: Improve the `README.rst` file.

KitwareMedical / ITKContourInterpolation

An implementation of morphological contour interpolation

http://hdl.handle.net/10380/3563

Apache License 2.0

30 stars 13 forks source link

STYLE: Improve the `README.rst` file. #81

Closed jhlegarreta closed 5 years ago

jhlegarreta commented 5 years ago

Improve the README.rst file style, and conform to the ITKModuleTemplate conventions:

Use the remote module project name as the title.
Place the CI badges in a table.
Divide the file into sections.
Cross-reference the LICENSE file.
Prefer ASCII inverted double quotation marks over non-ASCII inverted open/close quotation marks.

jhlegarreta commented 5 years ago

True that for the moment the ITKModuleTemplate does not dictate the separation into sections, cross-referencing the LICENSE file, etc. But it has been an extended practice, and helps readability. So may be it should. If yes, I'll do that.