Go to file

Adriaan de Groot 1623164e0e [libcalamares] Retire RETRANSLATE_FOR - Writing out the lambda is not a difficult job.		2022-05-13 16:27:02 +02:00
.github	CI: make CI scripts more consistent	2022-04-25 15:28:35 +02:00
.reuse
.tx
ci	CI: accept clang-format 12-14	2022-05-10 00:07:41 +02:00
CMakeModules	CMake: use modern FindPython and FindBoost	2022-04-25 14:36:16 +02:00
data	FreeBSD: Calamares is in the official ports-tree already	2021-11-29 14:45:30 +01:00
lang	Merge branch 'calamares' into work-3.3	2022-05-04 11:59:46 +02:00
LICENSES
man
src	[libcalamares] Retire RETRANSLATE_FOR	2022-05-13 16:27:02 +02:00
.clang-format	CI: demand clang-format 12 or 13	2022-02-01 16:23:39 +01:00
.editorconfig
.gersemirc	SPDX: tag gersemi configuration	2022-04-12 15:30:35 +02:00
.git-blame-ignore-revs	Git: add a blame-ignore file for large-scale reformatting	2022-04-23 21:23:33 +02:00
.gitattributes	REUSE: administrative and repo-meta files	2020-08-26 02:22:49 +02:00
.gitignore
.gitmodules
AUTHORS	modules/bootloader: Use the correct names for the shim binaries	2021-01-30 05:37:41 -05:00
calamares.desktop	i18n: [desktop] Automatic merge of Transifex translations	2022-03-29 00:27:36 +02:00
calamares.desktop.in
CalamaresConfig.cmake.in
CHANGES-3.2	Changes: document new settings in the users module.	2022-05-09 15:01:49 +02:00
CHANGES-3.3	[displaymanager] kdm is no longer relevant	2022-05-04 00:24:43 +02:00
cmake_uninstall.cmake.in
CMakeLists.txt	CMake: fix Python3-executable uses	2022-05-10 00:07:41 +02:00
com.github.calamares.calamares.policy
CONTRIBUTING.md	Changes: update requirements / dependencies documentation	2021-09-28 23:59:45 +02:00
io.calamares.calamares.appdata.xml
README.md	Docs: link to GPLv3+	2021-12-21 01:02:13 +01:00
settings.conf	Add zfs module to settings.conf	2021-11-16 09:34:50 -06:00

README.md

Calamares: Distribution-Independent Installer Framework

Report a Bug	Translate	Contribute	Matrix: #calamares:kde.org	IRC: Libera.Chat #calamares	Wiki

Calamares is a distribution-independent system installer, with an advanced partitioning feature for both manual and automated partitioning operations. Calamares is designed to be customizable by distribution maintainers without need for cumbersome patching, thanks to third party branding and external modules support.

Target Audience

Calamares is a Linux installer; users who install Linux on a computer will hopefully use it just once, to install their Linux distribution. Calamares is not a "ready to use" application: distributions apply a huge amount of customisation and configuration to Calamares, and the target audience for this repository is those distributions, and the people who make those Linux distro's.

Calamares has some generic user documentation for end-users, but most of what we have is for distro developers.

Getting Calamares

Clone Calamares from GitHub. The default branch is called calamares.

git clone https://github.com/calamares/calamares.git

Calamares is a KDE-Frameworks and Qt-based, C++17, CMake-built application. The dependencies are explained in CONTRIBUTING.md.

Contributing to Calamares

Calamares welcomes PRs. New issues are welcome, too. There are both the Calamares core repository (this one), and an extensions repository (Calamares extensions).

Contributions to code, modules, documentation, the wiki and the website are all welcome. There is more information in the CONTRIBUTING.md file.

Join the Conversation

GitHub Issues are one place for discussing Calamares if there are concrete problems or a new feature to discuss.

Regular Calamares development chit-chat happens in a Matrix room, #calamares:kde.org. The conversation is bridged with IRC on Libera.Chat. Responsiveness is best during the day in Europe, but feel free to idle. If you use IRC, DO NOT ask-and-leave. Keep that chat window open because it can easily take a few hours for someone to notice a message. Matrix is persistent, and we'll see your message eventually.