aiden
/
calamares
mirror of https://github.com/cutefishos/calamares
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
CutefishOS Installer.
2,140 Commits
1 Branch
0 Tags
74 MiB
C++ 79.2%
Python 8.3%
CMake 5.9%
QML 4.9%
Shell 1.3%
Other 0.4%
 
 
 
 
 
 
Go to file
Teo Mrnjavac 3a6eb3b790 Correctly fail when YAML-CPP is not found.
.tx Add Transifex repo config.
CMakeModules Correctly fail when YAML-CPP is not found.
ci Fix permissions.
data/images New icon, PNG.
hacking Update RELEASE.md
lang Automatic merge of Transifex translations
src Revert "Merge pull request from calamares/qtwebengine"
thirdparty Update submodule
.editorconfig Added .editorconfig
.gitattributes Add testmodule.py and globalStorage.yaml to export-ignore for tarballs.
.gitignore Update .gitignore.
.gitmodules Update submodule back to upstream.
AUTHORS AUTHORS file.
CMakeLists.txt Correctly fail when YAML-CPP is not found.
CalamaresAddBrandingSubdirectory.cmake Rely on CMake if the branding component has a CMakeLists.txt.
CalamaresAddLibrary.cmake Add proper QResrouce system to libcalamaresui, finish up prepare checks
CalamaresAddModuleSubdirectory.cmake Allow and glob multiple .conf files in module subdirectory.
CalamaresAddPlugin.cmake Allow and glob multiple .conf files in module subdirectory.
CalamaresBuildTreeSettings.cmake.in CMake skeleton.
CalamaresConfig.cmake.in We have a Python API for jobmodules!
CalamaresConfigVersion.cmake.in CMake skeleton.
CalamaresUse.cmake.in New CalamaresAddBrandingSubdirectory macro.
HACKING.md Update HACKING.md
LICENSE Update LICENSE
README.md Update README.md
calamares.desktop Use pkexec to execute calamares with the right permissions
cmake_uninstall.cmake.in CMake skeleton.
com.github.calamares.calamares.policy Rename pkexec policy file to .policy extension.
settings.conf Update settings defaults.

README.md

Calamares: Distribution-Independent Installer Framework

GitHub release Build Status Coverity Scan Build Status GitHub license

Report a Bug Contribute Translate Freenode (IRC): #calamares

Dependencies

Main:

  • Compiler with C++11 support: GCC >= 4.9.0 or Clang >= 3.5.1
  • CMake >= 2.8.12
  • Qt >= 5.3
  • yaml-cpp >= 0.5.1
  • Python >= 3.3
  • Boost.Python >= 1.55.0
  • dmidecode

Modules:

  • welcome:
  • NetworkManager
  • UPower
  • partition:
  • extra-cmake-modules
  • KF5: KCoreAddons, KConfig, KI18n, KIconThemes, KIO, KService
  • KPMcore >= 2.1
  • sgdisk
  • bootloader:
  • systemd-boot or GRUB
  • sgdisk
  • unpackfs:
  • squashfs-tools
  • rsync

Deployment

Setting up branding

Working with modules

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 ..
$ make

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.

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).
  1. 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.
  1. calamares - The main executable.
  • A thin wrapper around libcalamaresui; starts up and plugs together all the parts.