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.

45 lines
1.3 KiB
Markdown

11 years ago
Calamares
11 years ago
=========
Distribution-independent installer framework
11 years ago
10 years ago
[![Build Status](http://calamares.pangea.pub/buildStatus/icon?job=calamares-master)](http://calamares.pangea.pub/job/calamares-master/)
11 years ago
### Dependencies
* CMake >= 2.8.12
* Qt >= 5.3
11 years ago
* yaml-cpp >= 0.5.1
* Python >= 3.3
* Boost.Python >= 1.55.0
11 years ago
Additional dependencies, only for the partitioning module:
* extra-cmake-modules
11 years ago
* kconfig (part of KF5)
* solid (part of KF5)
* kcoreaddons (part of KF5)
* ki18n (part of KF5)
11 years ago
### Building
```
$ git submodule init
$ git submodule update
11 years ago
$ mkdir build
$ cd build
11 years ago
$ cmake -DCMAKE_BUILD_TYPE=Debug ..
11 years ago
$ make
```
11 years ago
### Design notes
11 years ago
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.