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.
55 lines
2.7 KiB
Markdown
55 lines
2.7 KiB
Markdown
### Calamares: Distribution-Independent Installer Framework
|
|
---------
|
|
|
|
[](https://github.com/calamares/calamares/releases)
|
|
[](https://calamares.io/ci/job/calamares-master/)
|
|
[](https://scan.coverity.com/projects/5389)
|
|
[](https://github.com/calamares/calamares/blob/master/LICENSE)
|
|
|
|
| [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 |
|
|
|:-----------------------------------------:|:----------------------:|:-----------------------:|:--------------------------:|
|
|
|
|
### Dependencies
|
|
|
|
Compiler with C++11 support: GCC >= 4.8.4 or Clang >= 3.5.1
|
|
|
|
| Main | Welcome module | Partitioning module | Bootloader module | Unpackfs module |
|
|
|:----:|:--------------:|:-------------------:|:-----------------:|:---------------:|
|
|
| CMake >= 2.8.12 | NetworkManager | extra-cmake-modules | systemd-boot or GRUB2 | squashfs-tools |
|
|
| 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 | | |
|
|
|
|
### Deployment
|
|
[__Setting up branding__](https://github.com/calamares/calamares/blob/master/src/branding/README.md)
|
|
|
|
[__Working with modules__](https://github.com/calamares/calamares/blob/master/src/modules/README.md)
|
|
|
|
|
|
### Building
|
|
Clone Calamares from GitHub and `cd` into the calamares directory, then:
|
|
```
|
|
$ git submodule init
|
|
$ git submodule update
|
|
$ mkdir build
|
|
$ cd build
|
|
$ cmake -DCMAKE_BUILD_TYPE=Debug -DWITH_PARTITIONMANAGER=1 ..
|
|
$ 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.
|
|
* Supports branding components.
|
|
* 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.
|