search

InsightSoftwareConsortium / ITKThickness3D

An ITK module to compute 3D thickness
Apache License 2.0
41 stars 18 forks source link

ENH: Transition `README`to reSTructuredText. #9

Closed jhlegarreta closed 5 years ago

jhlegarreta commented 5 years ago

Transition README to reSTructuredText to conform to the ITKModuleTemplate guidelines.

Take advantage of the commit to fix some typos.

Remove trailing whitespaces.

jhlegarreta commented 5 years ago

@T4mmi thanks for the review ! Yes, I missed that.

The ITKModuleTemplate does implicitly recommend using reSTructuredText. I guess the Cookiecutter module used to generate the files created an .rst. It is more about consistency. There are many subtleties throughout the toolkit that we may disagree on, but keeping consistency is an important aspect beyond our own choices !

T4mmi commented 5 years ago

Actually coockiecutter did create a reStructureText README, I did convert it to markdown 😐 But you're right about consistency !

jhlegarreta commented 5 years ago

Thanks for understanding Thomas, and sorry if you took the time to convert it to Markdown.

T4mmi commented 5 years ago

No problem, I'm learning 😉