2014-06-03 13:30:39 -07:00
|
|
|
Calamares
|
2014-06-03 13:03:07 -07:00
|
|
|
=========
|
|
|
|
|
|
|
|
|
|
Distribution-independent installer framework
|
2014-06-03 13:30:39 -07:00
|
|
|
|
2014-12-18 14:18:22 -08:00
|
|
|
[Report bugs here](http://calamares.io/bugs/)
|
2014-12-03 12:24:36 -08:00
|
|
|
|
|
|
|
|
|
2014-12-18 14:18:22 -08:00
|
|
|
[](http://calamares.pangea.pub/ci/job/calamares-master/)
|
2014-10-29 03:57:19 -07:00
|
|
|
|
2014-06-04 07:47:55 -07:00
|
|
|
### Dependencies
|
|
|
|
|
* CMake >= 2.8.12
|
|
|
|
|
* Qt >= 5.3
|
2014-07-16 07:41:47 -07:00
|
|
|
* yaml-cpp >= 0.5.1
|
|
|
|
|
* Python >= 3.3
|
|
|
|
|
* Boost.Python >= 1.55.0
|
2014-08-13 08:53:40 -07:00
|
|
|
|
|
|
|
|
Additional dependencies, only for the partitioning module:
|
2014-07-24 10:03:49 -07:00
|
|
|
* extra-cmake-modules
|
2014-08-13 08:53:40 -07:00
|
|
|
* kconfig (part of KF5)
|
|
|
|
|
* solid (part of KF5)
|
|
|
|
|
* kcoreaddons (part of KF5)
|
|
|
|
|
* ki18n (part of KF5)
|
2014-06-04 07:47:55 -07:00
|
|
|
|
|
|
|
|
### Building
|
|
|
|
|
```
|
2014-06-26 07:46:06 -07:00
|
|
|
$ git submodule init
|
|
|
|
|
$ git submodule update
|
2014-06-04 07:47:55 -07:00
|
|
|
$ mkdir build
|
|
|
|
|
$ cd build
|
2014-06-11 04:38:43 -07:00
|
|
|
$ cmake -DCMAKE_BUILD_TYPE=Debug ..
|
2014-06-04 07:47:55 -07:00
|
|
|
$ make
|
|
|
|
|
```
|
|
|
|
|
|
2014-06-03 13:34:42 -07:00
|
|
|
### Design notes
|
2014-07-16 07:41:47 -07:00
|
|
|
Calamares is currently split as follows:
|
|
|
|
|
* libcalamares - the backend 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);
|
|
|
|
|
* libcalamaresui - the frontend 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 backend library;
|
|
|
|
|
* calamares - the main executable,
|
|
|
|
|
* a thin wrapper around libcalamaresui, starts up and plugs together all the parts.
|
