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-21 02:10:09 +01: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)
|
2021-01-28 14:21:57 +01:00
|
|
|
[](https://github.com/calamares/calamares/actions?query=workflow%3Aci)
|
2021-12-19 12:54:39 +01:00
|
|
|
[](https://github.com/calamares/calamares/blob/calamares/LICENSES/LGPL-3.0-or-later.txt)
|
2015-06-13 18:32:16 +02:00
|
|
|
|
2020-10-31 23:04:47 +01:00
|
|
|
|
2021-06-15 11:29:49 +02:00
|
|
|
| [Report a Bug](https://github.com/calamares/calamares/issues/new) | [Translate](https://www.transifex.com/projects/p/calamares/) | [Contribute](CONTRIBUTING.md) | [Matrix: #calamares:kde.org](https://webchat.kde.org/#/room/%23calamares:kde.org) | [IRC: Libera.Chat #calamares](https://kiwiirc.com/client/irc.libera.chat/#calamares) | [Wiki](https://github.com/calamares/calamares/wiki) |
|
2021-05-19 14:57:33 +02:00
|
|
|
|:--:|:--:|:--:|:--:|:--:|:--:|
|
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
|
|
|
|
|
> 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.
|
|
|
|
|
|
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 12:54:27 +01: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.
|
|
|
|
|
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
|
|
|
|
|
|
|
|
Contributions to code, modules, documentation, the wiki and the website are all welcome.
|
|
|
|
|
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.
|
|
|
|
|
|
2021-06-15 11:29:49 +02:00
|
|
|
Regular Calamares development chit-chat happens in a [Matrix](https://matrix.org/)
|
|
|
|
|
room, `#calamares:kde.org`. The conversation is bridged with IRC
|
|
|
|
|
on [Libera.Chat](https://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.
|
2020-09-30 10:53:04 +02:00
|
|
|
|
2021-05-19 15:21:05 +02:00
|
|
|
* [](https://webchat.kde.org/#/room/%23calamares:kde.org)
|
2021-05-31 10:41:49 +02:00
|
|
|
* [](https://kiwiirc.com/client/irc.libera.chat/#calamares)
|
