README.md

   1 <!-- SPDX-FileCopyrightText: no
   2      SPDX-License-Identifier: CC0-1.0
   3 -->
   4 # !!! Attention !!!
   5 **This repository will be archive!**
   6 ---------
   7 # Calamares: Distribution-Independent Installer Framework
   8 ---------
   9
  10 [![GitHub release](https://img.shields.io/github/release/calamares/calamares.svg)](https://github.com/calamares/calamares/releases)
  11 [![GitHub Build Status](https://img.shields.io/github/workflow/status/calamares/calamares/ci?label=GH%20build)](https://github.com/calamares/calamares/actions?query=workflow%3Aci)
  12 [![Travis Build Status](https://travis-ci.org/calamares/calamares.svg?branch=calamares)](https://travis-ci.org/calamares/calamares)
  13 [![Coverity Scan Build Status](https://scan.coverity.com/projects/5389/badge.svg)](https://scan.coverity.com/projects/5389)
  14 [![GitHub license](https://img.shields.io/github/license/calamares/calamares.svg)](https://github.com/calamares/calamares/blob/calamares/LICENSE)
  15
  16 [If you find a Bug, please report a Bug](https://github.com/SereneTeam/alterlinux-calamares/issues/new/choose)
  17
  18 ***
  19
  20 ### Dependencies
  21
  22 Main:
  23 * Compiler with C++14 support: [GCC](https://www.archlinux.org/packages/core/x86_64/gcc/) >= 5 or [Clang](https://www.archlinux.org/packages/extra/x86_64/clang/) >= 3.5.1
  24 * [CMake](https://www.archlinux.org/packages/extra/x86_64/cmake/) >= 3.3
  25 * [Qt](https://www.archlinux.org/packages/extra/x86_64/qt5-base/) >= 5.9
  26 * [yaml-cpp](https://www.archlinux.org/packages/community/x86_64/yaml-cpp/) >= 0.5.1
  27 * [Python](https://www.archlinux.org/packages/extra/x86_64/python/) >= 3.3 (required for some modules)
  28 * [Boost.Python](https://www.archlinux.org/packages/extra/x86_64/boost/) and [Boost-libs](https://www.archlinux.org/packages/extra/x86_64/boost-libs/) >= 1.55.0 (required for some modules)
  29 * [KDE extra-cmake-modules](https://www.archlinux.org/packages/extra/any/extra-cmake-modules/) >= 5.18 (recommended; required for some modules;
  30   required for some tests)
  31 * [KDE Frameworks KCoreAddons](https://www.archlinux.org/packages/extra/x86_64/kcoreaddons/) (>= 5.58 recommended)
  32 * ~~PythonQt (optional, deprecated)~~ (Not available)
  33
  34 Modules:
  35 * Individual modules may have their own requirements;
  36   these are listed in CMake output. Particular requirements (not complete):
  37 * *fsresizer* [KPMCore](https://www.archlinux.org/packages/community/x86_64/kpmcore/) >= 3.3 (>= 4.1 recommended)
  38 * *partition* [KPMCore](https://www.archlinux.org/packages/community/x86_64/kpmcore/) >= 3.3 (>= 4.1 recommended)
  39 * *users* [LibPWQuality](https://www.archlinux.org/packages/extra/x86_64/libpwquality/) (optional)
  40
  41 ### Building (Vanilla)
  42
  43 Clone Calamares from GitHub. The default branch is called *calamares*.
  44
  45 ```
  46 git clone https://github.com/calamares/calamares.git
  47 ```
  48
  49 Calamares is a KDE-Frameworks and Qt-based, C++17, CMake-built application.
  50 The dependencies are explained in [CONTRIBUTING.md](CONTRIBUTING.md).
  51
  52 ## Contributing to Calamares
  53
  54 Calamares welcomes PRs. New issues are welcome, too.
  55 There are both the Calamares **core** repository (this one),
  56 and an *extensions** repository ([Calamares extensions](https://github.com/calamares/calamares-extensions).
  57
  58 Contributions to code, modules, documentation, the wiki and the website are all welcome.
  59 There is more information in the [CONTRIBUTING.md](CONTRIBUTING.md) file.
  60
  61 ## Join the Conversation
  62
  63 GitHub Issues are **one** place for discussing Calamares if there are concrete
  64 problems or a new feature to discuss.
  65
  66 Regular Calamares development chit-chat happens on old-school IRC
  67 (no registration required). Responsiveness is best during the day
  68 in Europe, but feel free to idle.
  69
  70 [![Visit our IRC channel](https://kiwiirc.com/buttons/webchat.freenode.net/calamares.png)](https://webchat.freenode.net/?channel=#calamares?nick=guest|)