From 1d51e5cb04ea376e68a48c9ccc8851291b98b0e5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jon=20Haitz=20Legarreta=20Gorro=C3=B1o?= Date: Sat, 27 Oct 2018 20:06:13 -0400 Subject: [PATCH] DOC: Format remote module documentation README to markdown. Format the remote module documentation `README` file to markdown. Take advantage of the commit to improve the style and the contents. Change-Id: I1ceee86a80a41a86b93bb9faf93a49381382b560 --- Modules/Remote/README.md | 27 +++++++++++++++++++++++++++ Modules/Remote/README.txt | 18 ------------------ 2 files changed, 27 insertions(+), 18 deletions(-) create mode 100644 Modules/Remote/README.md delete mode 100644 Modules/Remote/README.txt diff --git a/Modules/Remote/README.md b/Modules/Remote/README.md new file mode 100644 index 00000000000..95dd15ad028 --- /dev/null +++ b/Modules/Remote/README.md @@ -0,0 +1,27 @@ +Introduction +============ + +This directory is a place-holder for all remote modules distributed outside +ITK's main repository. Remote modules share the same directory structure as +modules in the main repository. They will be picked up by the configuration +system and entered into the build after they are downloaded into this +directory. + +Modules can easily be downloaded and made accessible to the community by +listing the module in the current directory. For more information on the +policy and procedures for adding a new module, please visit the +[Contributing with a Remote Module](https://itk.org/ITKSoftwareGuide/html/Book1/ITKSoftwareGuide-Book1ch9.html#x55-1640009.7) in the [ITK Software Guide]. + +For more information on adding a new module to the list of new modules, +please visit the [ITKModuleTemplate](https://github.com/InsightSoftwareConsortium/ITKModuleTemplate) repository. + +Note that in each `.remote.cmake` file, the first argument +of the function `itk_fetch_module()` is the name of the remote module, and it +has to be consistent with the module name defined in the correponding +`.remote.cmake` file. + +To better distinguish the remote modules from the internal ITK modules, the names +of the remote modules should **not** contain the "ITK" string prefix in them. + + +[ITK Software Guide]: https://itk.org/ItkSoftwareGuide.pdf diff --git a/Modules/Remote/README.txt b/Modules/Remote/README.txt deleted file mode 100644 index 66d92beee78..00000000000 --- a/Modules/Remote/README.txt +++ /dev/null @@ -1,18 +0,0 @@ -This directory is a place-holder for all remote modules distributed outside ITK's -main repository. Remote modules share the same directory structure as modules -in the main repository. They will be picked up by the configuration system and -entered into the build after they are downloaded into this directory. - -Modules can be easily downloaded and accessible to the community by listing the -module in the current directory. For more information on adding a new module to -the list of new modules, see the page that describes the policy and procedures -for adding a new module: - - https://www.itk.org/Wiki/ITK/Policy_and_Procedures_for_Adding_Remote_Modules - - -**Note that in each .remote.cmake, the first argument of the -function itk_fetch_module() is the name of the remote module, and it has to be -consistent with the module name defined in the correponding itk-module.cmake. -To better distinguish the remote modules from the internal ITK modules, the names -of the remote modules should not contain the "ITK" string prefix in them.