Distribution-independent installer framework

Go to file

Philip Mueller abf3bdb69d Merge branch 'calamares' of https://github.com/calamares/calamares into development		2024-12-23 08:37:05 +07:00
.github	CI: run tests in the weekly build	2024-07-20 22:25:28 +02:00
.reuse	SPDX: remove license information for removed module-translations	2022-08-25 00:26:31 +02:00
.tx	i18n: update Transifex configuration	2023-04-24 22:43:06 +02:00
3rdparty	Python: use the vendored pybind11	2023-10-16 20:07:39 +02:00
ci	CI: be a little more chatty with the language lists	2024-11-29 13:31:02 +01:00
CMakeModules	CMake: repair KPMcore helper for KF5 (legacy) case	2024-11-21 23:42:39 +01:00
data	[data] fix polkit script	2024-01-03 14:36:10 +07:00
lang	[libcalamares] Deal with deprecations in XML QDomDocument	2024-12-02 22:57:49 +01:00
LICENSES	[calamares] Use DBus activation instead of KDSAG	2021-09-16 13:48:56 +02:00
man	Changes: update Calamares manpage	2020-09-29 16:41:57 +02:00
src	Merge branch 'calamares' of https://github.com/calamares/calamares into development	2024-12-23 08:37:05 +07:00
.clang-format	CI: use clang-format to add braces	2023-10-17 22:17:01 +02:00
.editorconfig	REUSE: administrative and repo-meta files	2020-08-26 02:22:49 +02:00
.gersemirc	SPDX: tag gersemi configuration	2022-04-12 15:30:35 +02:00
.git-blame-ignore-revs	Git: update blame-ignore	2022-05-18 12:45:32 +02:00
.gitattributes	REUSE: administrative and repo-meta files	2020-08-26 02:22:49 +02:00
.gitignore	CI: adjust to clang-format-10 automatically	2020-09-21 16:15:51 +02:00
.gitmodules	Remove libcrashreporter-qt more thoroughly	2017-09-13 08:47:07 -04:00
.travis.yml	Merge branch 'calamares' of https://github.com/calamares/calamares into development	2020-10-29 20:39:53 +01:00
AUTHORS	AUTHORS: update list of contributors	2024-02-17 12:14:22 +01:00
calamares.desktop	i18n: [desktop] Automatic merge of Transifex translations	2023-08-06 23:41:28 +02:00
calamares.desktop.in	[calamares] Change .desktop invocation	2021-03-15 10:25:25 +01:00
CalamaresConfig.cmake.in	CMake: repair KDE Frameworks 6 dependencies	2024-11-21 22:50:44 +01:00
CHANGES-3.2	Changes: close off the 3.2 changelog in the development branch	2022-08-24 23:35:19 +02:00
CHANGES-3.3	Changes: pre-release housekeeping	2024-11-21 22:53:17 +01:00
cmake_uninstall.cmake.in	REUSE: administrative and repo-meta files	2020-08-26 02:22:49 +02:00
CMakeLists.txt	CMake: suppress install-path warnings with newer CMake	2024-12-21 14:43:40 +01:00
com.github.calamares.calamares.policy	[polkit] update policy	2024-06-20 09:58:33 +07:00
CONTRIBUTING.md	Docs: add a note about updating / uploading translations	2024-08-13 15:49:05 +02:00
io.calamares.calamares.appdata.xml	REUSE: administrative and repo-meta files	2020-08-26 02:22:49 +02:00
README.md	docs: drop mention of IRC, prefer Matrix for communication	2023-08-27 22:42:44 +02:00
settings.conf	[merge] from upstream	2024-08-14 10:10:36 +07:00

README.md

Calamares: Distribution-Independent Installer Framework

Report a Bug	Translate	Contribute	Chat on Matrix: #calamares:kde.org	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 the 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 customization and configuration to Calamares, and the target audience for this repository is those distributions, and the people who make those Linux distros.

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. Issues are not a help channel. Visit Matrix for help with configuration or compilation.

Regular Calamares development chit-chat happens in a Matrix room, #calamares:kde.org. Responsiveness is best during the day in Europe, but feel free to idle. Matrix is persistent, and we'll see your message eventually.

(needs a Matrix account)