Distribution-independent installer framework

Go to file

Adriaan de Groot f352740aba Git: update blame-ignore		2022-05-18 12:45:32 +02:00
.github	CI: make CI scripts more consistent	2022-04-25 15:28:35 +02:00
.reuse	REUSE: the CI actions are uninteresting	2021-03-09 13:52:13 +01:00
.tx	REUSE: administrative and repo-meta files	2020-08-26 02:22:49 +02:00
3rdparty	[3rdparty] Warnings-- (override) in KDSAG	2020-09-22 22:37:19 +02:00
ci	CI: acceptable clang-format versions	2022-05-18 12:22:51 +02:00
CMakeModules	CMake: if pylint is available, run it as part of the test-suite	2021-09-27 21:02:18 +02:00
data	FreeBSD: Calamares is in the official ports-tree already	2021-11-29 14:45:30 +01:00
lang	i18n: [calamares] Automatic merge of Transifex translations	2022-05-18 11:52:43 +02:00
LICENSES	REUSE: LICENSES/ files	2020-08-26 01:06:55 +02:00
man	Changes: update Calamares manpage	2020-09-29 16:41:57 +02:00
src	CI: apply coding style globally again	2022-05-18 12:44:55 +02:00
.clang-format	CI: demand clang-format 12 or 13	2022-02-01 16:23:39 +01:00
.editorconfig	REUSE: administrative and repo-meta files	2020-08-26 02:22:49 +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
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	[calamares] Change .desktop invocation	2021-03-15 10:25:25 +01:00
CalamaresConfig.cmake.in	CMake: find YAMLCPP when asked to find Calamares	2021-07-23 17:37:12 +02:00
CHANGES-3.2	Changes: pre-release housekeeping	2022-05-18 12:05:45 +02:00
cmake_uninstall.cmake.in	REUSE: administrative and repo-meta files	2020-08-26 02:22:49 +02:00
CMakeLists.txt	Changes: pre-release housekeeping	2022-05-18 12:05:45 +02:00
com.github.calamares.calamares.policy	REUSE: administrative and repo-meta files	2020-08-26 02:22:49 +02:00
CONTRIBUTING.md	Docs: do not use freenode	2021-06-15 11:29:49 +02:00
io.calamares.calamares.appdata.xml	REUSE: administrative and repo-meta files	2020-08-26 02:22:49 +02:00
README.md	Docs: suggest IRC for non-account chat	2022-05-17 11:01:06 +02: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.

(needs a Matrix account)
(IRC supports guest accounts)