README.md

   1 <!-- SPDX-FileCopyrightText: no
   2      SPDX-License-Identifier: CC0-1.0
   3 -->
   4
   5 # Calamares: Distribution-Independent Installer Framework
   6 ---------
   7
   8 [![GitHub release](https://img.shields.io/github/release/calamares/calamares.svg)](https://github.com/calamares/calamares/releases)
   9 [![Travis Build Status](https://travis-ci.org/calamares/calamares.svg?branch=calamares)](https://travis-ci.org/calamares/calamares)
  10 [![Coverity Scan Build Status](https://scan.coverity.com/projects/5389/badge.svg)](https://scan.coverity.com/projects/5389)
  11 [![GitHub license](https://img.shields.io/github/license/calamares/calamares.svg)](https://github.com/calamares/calamares/blob/calamares/LICENSE)
  12
  13
  14 | [Report a Bug](https://github.com/calamares/calamares/issues/new) | [Translate](https://www.transifex.com/projects/p/calamares/) | [Contribute](CONTRIBUTING.md) | [Freenode (IRC): #calamares](https://webchat.freenode.net/?channel=#calamares?nick=guest) | [Wiki](https://github.com/calamares/calamares/wiki) |
  15 |:--:|:--:|:--:|:--:|:--:|
  16
  17
  18 > Calamares is a distribution-independent system installer, with an advanced partitioning
  19 > feature for both manual and automated partitioning operations. Calamares is designed to
  20 > be customizable by distribution maintainers without need for cumbersome patching,
  21 > thanks to third party branding and external modules support.
  22
  23 ## Target Audience
  24
  25 Calamares is a Linux installer; users who install Linux on a computer will hopefully
  26 use it just **once**, to install their Linux distribution. Calamares is not
  27 a "ready to use" application: distributions apply a huge amount of customisation
  28 and configuration to Calamares, and the target audience for this repository
  29 is those distributions, and the people who make those Linux distro's.
  30
  31 Calamares has some [generic user documentation](https://github.com/calamares/calamares/wiki/Use-Guide)
  32 for end-users, but most of what we have is for distro developers.
  33
  34 ## Getting Calamares
  35
  36 Clone Calamares from GitHub. The default branch is called *calamares*.
  37
  38 ```
  39 git clone https://github.com/calamares/calamares.git
  40 ```
  41
  42 Calamares is a KDE-Frameworks and Qt-based, C++17, CMake-built application.
  43 The dependencies are explainged in [CONTRIBUTING.md](CONTRIBUTING.md).
  44
  45 ## Contributing to Calamares
  46
  47 Calamares welcomes PRs. New issues are welcome, too.
  48 There are both the Calamares **core** repository (this one),
  49 and an *extensions** repository ([Calamares extensions](https://github.com/calamares/calamares-extensions).
  50
  51 Contributions to code, modules, documentation, the wiki and the website are all welcome.
  52 There is more information in the [CONTRIBUTING.md](CONTRIBUTING.md) file.
  53
  54 ## Join the Conversation
  55
  56 GitHub Issues are **one** place for discussing Calamares if there are concrete
  57 problems or a new feature to discuss.
  58
  59 Regular Calamares development chit-chat happens on old-school IRC
  60 (no registration required). Responsiveness is best during the day
  61 in Europe, but feel free to idle.
  62
  63 [![Visit our IRC channel](https://kiwiirc.com/buttons/webchat.freenode.net/calamares.png)](https://webchat.freenode.net/?channel=#calamares?nick=guest|)