napcok/calamares
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Teo Mrnjavac 2014-07-16 17:08:05 +02:00
parent 2e38ad8016
commit 32beec0243
1 changed files with 11 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
src/modules/README.md
View File

@ -2,4 +2,14 @@ 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 implement the Calamares module API and can provide features like installer pages, batch jobs, etc.
To add a module, put it in a subdirectory and make sure it has a CMakeLists.txt, it should be picked up automatically by our CMake magic.
### 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.
### 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.