diff --git a/src/modules/README.md b/src/modules/README.md index 80a8ffbd9..a2ec06144 100644 --- a/src/modules/README.md +++ b/src/modules/README.md @@ -43,6 +43,12 @@ module's name, type, interface and possibly other properties. The name of the module as defined in `module.desc` must be the same as the name of the module's directory. +Module descriptors must have the following keys: +- *name* (an identifier; must be the same as the directory name) +- *type* ("job" or "view") +- *interface* (see below for the different interfaces; generally we + refer to the kinds of modules by their interface) + ## Module-specific configuration A Calamares module *may* read a module configuration file, @@ -77,6 +83,8 @@ or the experimental pythonqt job- and viewmodule interfaces. To add a Python or process jobmodule, put it in a subdirectory and make sure it has a `module.desc`. It will be picked up automatically by our CMake magic. +For all kinds of Python jobs, the key *script* must be set to the name of +the main python file for the job. This is almost universally "main.py". `CMakeLists.txt` is *not* used for Python and process jobmodules. diff --git a/src/modules/dummypython/module.desc b/src/modules/dummypython/module.desc index a952d62b4..ebe81af1a 100644 --- a/src/modules/dummypython/module.desc +++ b/src/modules/dummypython/module.desc @@ -4,4 +4,4 @@ type: "job" name: "dummypython" interface: "python" -script: "main.py" #assumed relative to the current directory +script: "main.py" diff --git a/src/modules/unpackfs/module.desc b/src/modules/unpackfs/module.desc index ea7e2bcad..67a56b06c 100644 --- a/src/modules/unpackfs/module.desc +++ b/src/modules/unpackfs/module.desc @@ -3,4 +3,4 @@ type: "job" name: "unpackfs" interface: "python" -script: "main.py" #assumed relative to the current directory +script: "main.py"