2015-02-21 02:22:27 +01:00
### Calamares: Distribution-Independent Installer Framework
2015-02-21 02:10:09 +01:00
---------
2014-06-03 22:03:07 +02:00
2015-06-13 18:34:26 +02:00
[](https://github.com/calamares/calamares/releases)
2015-09-27 12:43:08 +02:00
[](https://calamares.io/ci/job/calamares-post_commit/)
2015-06-13 18:32:16 +02:00
[](https://scan.coverity.com/projects/5389)
2015-06-13 18:34:26 +02:00
[](https://github.com/calamares/calamares/blob/master/LICENSE)
2015-06-13 18:32:16 +02:00
2015-06-21 00:57:43 +02:00
| [Report a Bug ](https://calamares.io/bugs/ ) | [Contribute ](https://github.com/calamares/calamares/blob/master/HACKING.md ) | [Translate ](https://www.transifex.com/projects/p/calamares/ ) | Freenode (IRC): #calamares |
2015-06-13 18:32:16 +02:00
|:-----------------------------------------:|:----------------------:|:-----------------------:|:--------------------------:|
2014-10-29 11:57:19 +01:00
2014-06-04 16:47:55 +02:00
### Dependencies
2015-06-12 03:05:16 +02:00
2015-08-04 11:45:14 +02:00
Compiler with C++11 support: GCC >= 4.9.0 or Clang >= 3.5.1
2015-06-12 03:05:16 +02:00
2015-06-12 18:01:04 +02:00
| Main | Welcome module | Partitioning module | Bootloader module | Unpackfs module |
|:----:|:--------------:|:-------------------:|:-----------------:|:---------------:|
2015-06-13 18:35:13 +02:00
| CMake >= 2.8.12 | NetworkManager | extra-cmake-modules | systemd-boot or GRUB2 | squashfs-tools |
2015-06-12 18:01:04 +02:00
| Qt >= 5.3 | UPower | kconfig (part of KF5) | sgdisk | rsync |
| yaml-cpp >= 0.5.1 | | solid (part of KF5) | | |
| Python >= 3.3 | | kcoreaddons (part of KF5) | | |
| Boost.Python >= 1.55.0 | | ki18n (part of KF5) | | |
| dmidecode | | sgdisk | | |
2014-06-04 16:47:55 +02:00
2015-05-07 16:43:17 +02:00
### Deployment
2015-05-07 16:45:08 +02:00
[__Setting up branding__ ](https://github.com/calamares/calamares/blob/master/src/branding/README.md )
2015-05-07 16:43:17 +02:00
2015-05-07 16:45:08 +02:00
[__Working with modules__ ](https://github.com/calamares/calamares/blob/master/src/modules/README.md )
2015-05-07 16:43:17 +02:00
2014-06-04 16:47:55 +02:00
### Building
2015-04-01 17:05:18 +02:00
Clone Calamares from GitHub and `cd` into the calamares directory, then:
2014-06-04 16:47:55 +02:00
```
2014-06-26 16:46:06 +02:00
$ git submodule init
$ git submodule update
2014-06-04 16:47:55 +02:00
$ mkdir build
$ cd build
2015-07-01 18:58:01 +02:00
$ cmake -DCMAKE_BUILD_TYPE=Debug ..
2014-06-04 16:47:55 +02:00
$ make
```
2015-08-03 17:58:33 +02:00
#### Supported variables for CMake
* `WITH_PYTHON` - if this is set to false, the Python module interface will not be built. Default is true.
* `SKIP_MODULES` - takes a space-separated list of module names that should not be built even if present in `src/modules` (e.g. `cmake -DSKIP_MODULES="partition mount umount welcome" ..` ). Default is empty.
2015-02-21 02:10:09 +01:00
### Design Notes
2015-02-21 02:13:09 +01:00
Calamares is currently split as follows:
2015-02-21 02:12:00 +01:00
1. __libcalamares__ - The back-end library.
* Only depends on QtCore, yaml-cpp, Python and Boost.Python.
* Provides a job queue and generic jobs.
* Comes with 3 job interfaces: C++, Python and process (the latter is very limited).
2. __libcalamaresui__ - The front-end library.
* Same dependencies as libcalamares, plus QtWidgets and other Qt modules.
* Comes with a module loading system, for different kinds of plugins.
2015-05-07 16:47:33 +02:00
* Supports branding components.
2015-02-21 02:12:00 +01:00
* Presents a bunch of pages in a scripted order, enqueues jobs in the back-end library.
3. __calamares__ - The main executable.
* A thin wrapper around libcalamaresui; starts up and plugs together all the parts.
