mirror of https://github.com/cutefishos/calamares
You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
39 lines
1.7 KiB
Markdown
39 lines
1.7 KiB
Markdown
### Calamares: Distribution-Independent Installer Framework
|
|
---------
|
|
|
|
| [](http://calamares.io/ci/job/calamares-master/) | [Report a Bug](http://calamares.io/bugs/) | [Contribute](https://github.com/calamares/calamares/blob/master/HACKING.md) | Freenode (IRC): #calamares |
|
|
|:-----------------------------------------:|:--------------------------:|:--------------------------:|:--------------------------:|
|
|
|
|
### Dependencies
|
|
| Main | Partitioning Module |
|
|
|:----:|:-------------------:|
|
|
| CMake >= 2.8.12 | extra-cmake-modules |
|
|
| Qt >= 5.3 | kconfig (part of KF5) |
|
|
| 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) |
|
|
|
|
### Building
|
|
```
|
|
$ git submodule init
|
|
$ git submodule update
|
|
$ mkdir build
|
|
$ cd build
|
|
$ cmake -DCMAKE_BUILD_TYPE=Debug ..
|
|
$ make
|
|
```
|
|
|
|
### Design Notes
|
|
Calamares is currently split as follows:
|
|
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.
|
|
* Themeable, so branding can be done easily (plugin-based, TBD).
|
|
* 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.
|