From 846812f49b13d752a2123f5e1fc0f8d5541f87af Mon Sep 17 00:00:00 2001 From: Teo Mrnjavac Date: Wed, 16 Jul 2014 17:11:25 +0200 Subject: [PATCH] Update README.md --- src/modules/README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/src/modules/README.md b/src/modules/README.md index d80d360ac..250304aaf 100644 --- a/src/modules/README.md +++ b/src/modules/README.md @@ -1,15 +1,15 @@ Calamares modules directory === -Calamares modules are plugins that implement the Calamares module API and can provide features like installer pages, batch jobs, etc. +Calamares modules are plugins that provide features like installer pages, batch jobs, etc. Each Calamares module lives in its own directory. ### Qt plugin viewmodules Currently the only way to write a module which exposes one or more installer pages (viewmodule) is through a Qt plugin. Viewmodules should implement `Calamares::ViewStep`. They can also implement `Calamares::Job` to provide jobs. -To add a Qt plugin module, put it in a subdirectory and make sure it has a `module.conf` and a CMakeLists.txt with a `calamares_add_plugin` call. It will be picked up automatically by our CMake magic. +To add a Qt plugin module, put it in a subdirectory and make sure it has a `module.conf` and a `CMakeLists.txt` with a `calamares_add_plugin` call. It will be picked up automatically by our CMake magic. ### Python and process jobmodules -Batch jobs for Calamares can be written as Python scripts or as generic commands (shell scripts, external programs, etc.). To add a Python or process jobmodule, put it in a subdirectory and make sure it has a `module.conf`. It will be picked up automatically by our CMake magic. CMakeLists.txt is not used for Python and process jobmodules. +Batch jobs for Calamares can be written as Python scripts or as generic commands (shell scripts, external programs, etc.). To add a Python or process jobmodule, put it in a subdirectory and make sure it has a `module.conf`. It will be picked up automatically by our CMake magic. `CMakeLists.txt` is not used for Python and process jobmodules.