2020-08-26 01:41:30 +02:00
<!-- SPDX - FileCopyrightText: no
SPDX-License-Identifier: CC0-1.0
-->
2020-09-30 10:53:04 +02:00
# Calamares: Distribution-Independent Installer Framework
2015-02-20 20:10:09 -05:00
---------
2014-06-03 22:03:07 +02:00
2021-06-08 16:37:01 +02:00
[](https://github.com/calamares/calamares/labels/hacking%3A%20in-progress)
2015-06-13 18:34:26 +02:00
[](https://github.com/calamares/calamares/releases)
2023-01-02 19:19:57 +05:30
[](https://github.com/calamares/calamares/actions?query=workflow%3Aci)
2023-01-14 21:17:10 +05:30
[](https://github.com/calamares/calamares/tree/calamares/LICENSES)
2015-06-13 18:32:16 +02:00
2020-10-31 23:04:47 +01:00
2023-08-27 22:42:44 +02:00
| [Report a Bug ](https://github.com/calamares/calamares/issues/new ) | [Translate ](https://app.transifex.com/calamares/calamares/ ) | [Contribute ](CONTRIBUTING.md ) | [Chat on Matrix: #calamares:kde.org ](https://webchat.kde.org/#/room/%23calamares:kde.org ) | [Wiki ](https://github.com/calamares/calamares/wiki ) |
|:--:|:--:|:--:|:--:|:--:|
2020-10-31 23:04:47 +01:00
2014-10-29 11:57:19 +01:00
2020-09-30 10:53:04 +02:00
> Calamares is a distribution-independent system installer, with an advanced partitioning
> feature for both manual and automated partitioning operations. Calamares is designed to
2023-06-22 14:47:29 +03:30
> be customizable by distribution maintainers without the need for cumbersome patching,
> thanks to third-party branding and external modules support.
2020-09-30 10:53:04 +02:00
## 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
2023-06-22 14:47:29 +03:30
a "ready to use" application: distributions apply a huge amount of customization
2020-09-30 10:53:04 +02:00
and configuration to Calamares, and the target audience for this repository
2023-06-22 14:47:29 +03:30
is those distributions, and the people who make those Linux distros.
2020-09-30 10:53:04 +02:00
2021-05-19 14:24:01 +02:00
Calamares has some [generic user documentation ](https://calamares.io/docs/users-guide/ )
2020-09-30 10:53:04 +02:00
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
```
2020-10-25 11:54:27 +00:00
Calamares is a KDE-Frameworks and Qt-based, C++17, CMake-built application.
2020-11-02 16:21:12 +01:00
The dependencies are explained in [CONTRIBUTING.md ](CONTRIBUTING.md ).
2020-09-30 10:53:04 +02:00
## Contributing to Calamares
Calamares welcomes PRs. New issues are welcome, too.
2023-06-22 14:47:29 +03:30
There are both the Calamares **core** repository (this one)
2021-05-19 14:57:33 +02:00
and an **extensions** repository ([Calamares extensions ](https://github.com/calamares/calamares-extensions )).
2020-09-30 10:53:04 +02:00
2023-06-22 14:47:29 +03:30
Contributions to code, modules, documentation, the wiki, and the website are all welcome.
2020-09-30 10:53:04 +02:00
There is more information in the [CONTRIBUTING.md ](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.
2023-08-27 22:42:44 +02:00
Issues are not a help channel.
Visit Matrix for help with configuration or compilation.
2020-09-30 10:53:04 +02:00
2021-06-15 11:29:49 +02:00
Regular Calamares development chit-chat happens in a [Matrix ](https://matrix.org/ )
2023-08-27 22:42:44 +02:00
room, `#calamares:kde.org` . Responsiveness is best during the day
in Europe, but feel free to idle.
2021-06-15 11:29:49 +02:00
Matrix is persistent, and we'll see your message eventually.
2020-09-30 10:53:04 +02:00
2022-05-17 11:01:06 +02:00
* [](https://webchat.kde.org/#/room/ %23calamares:kde.org) (needs a Matrix account)
2023-08-27 22:42:44 +02:00
