README.md
1Introduction
2============
3
4This directory is a place-holder for all remote modules distributed outside
5ITK's main repository. Remote modules share the same directory structure as
6modules in the main repository. They will be picked up by the configuration
7system and entered into the build after they are downloaded into this
8directory.
9
10Modules can easily be downloaded and made accessible to the community by
11listing the module in the current directory. For more information on the
12policy and procedures for adding a new module, please visit the
13[Contributing with a Remote Module](https://itk.org/ITKSoftwareGuide/html/Book1/ITKSoftwareGuide-Book1ch9.html#x55-1640009.7) in the [ITK Software Guide].
14
15For more information on adding a new module to the list of new modules,
16please visit the [ITKModuleTemplate](https://github.com/InsightSoftwareConsortium/ITKModuleTemplate) repository.
17
18Note that in each `<remote module name>.remote.cmake` file, the first argument
19of the function `itk_fetch_module()` is the name of the remote module, and it
20has to be consistent with the module name defined in the correponding
21`<remote module name>.remote.cmake` file.
22
23To better distinguish the remote modules from the internal ITK modules, the names
24of the remote modules should **not** contain the "ITK" string prefix in them.
25
26
27[ITK Software Guide]: https://itk.org/ItkSoftwareGuide.pdf
28