OSDN Git Service

Merge tag 'v3.2.44.2'
[alterlinux/alterlinux-calamares.git] / README.md
index 3049fba..cc14df6 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,32 +1,46 @@
 <!-- SPDX-FileCopyrightText: no
      SPDX-License-Identifier: CC0-1.0
 -->
-
+# !!! Attention !!!
+**This repository will be archive!**
+--------- 
 # Calamares: Distribution-Independent Installer Framework
 ---------
 
+[![Current issue](https://img.shields.io/badge/issue-in_progress-FE9B48)](https://github.com/calamares/calamares/labels/hacking%3A%20in-progress)
 [![GitHub release](https://img.shields.io/github/release/calamares/calamares.svg)](https://github.com/calamares/calamares/releases)
-[![Travis Build Status](https://travis-ci.org/calamares/calamares.svg?branch=calamares)](https://travis-ci.org/calamares/calamares)
-[![Coverity Scan Build Status](https://scan.coverity.com/projects/5389/badge.svg)](https://scan.coverity.com/projects/5389)
+[![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)
 [![GitHub license](https://img.shields.io/github/license/calamares/calamares.svg)](https://github.com/calamares/calamares/blob/calamares/LICENSE)
 
-| [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) |
-|:-----------------------------------------:|:----------------------:|:-----------------------:|:--------------------------:|:--------------------------:|
+[If you find a Bug, please report a Bug](https://github.com/SereneTeam/alterlinux-calamares/issues/new/choose)
+
+| [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) |
+|:--:|:--:|:--:|:--:|:--:|:--:|
 
-> 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.
+### Dependencies
 
-## Target Audience
+Main:
+* 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
+* [CMake](https://www.archlinux.org/packages/extra/x86_64/cmake/) >= 3.3
+* [Qt](https://www.archlinux.org/packages/extra/x86_64/qt5-base/) >= 5.9
+* [yaml-cpp](https://www.archlinux.org/packages/community/x86_64/yaml-cpp/) >= 0.5.1
+* [Python](https://www.archlinux.org/packages/extra/x86_64/python/) >= 3.3 (required for some modules)
+* [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)
+* [KDE extra-cmake-modules](https://www.archlinux.org/packages/extra/any/extra-cmake-modules/) >= 5.18 (recommended; required for some modules;
+  required for some tests)
+* [KDE Frameworks KCoreAddons](https://www.archlinux.org/packages/extra/x86_64/kcoreaddons/) (>= 5.58 recommended)
+* ~~PythonQt (optional, deprecated)~~ (Not available)
 
-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.
+Modules:
+* Individual modules may have their own requirements;
+  these are listed in CMake output. Particular requirements (not complete):
+* *fsresizer* [KPMCore](https://www.archlinux.org/packages/community/x86_64/kpmcore/) >= 3.3 (>= 4.1 recommended)
+* *partition* [KPMCore](https://www.archlinux.org/packages/community/x86_64/kpmcore/) >= 3.3 (>= 4.1 recommended)
+* *users* [LibPWQuality](https://www.archlinux.org/packages/extra/x86_64/libpwquality/) (optional)
 
-Calamares has some [generic user documentation](https://github.com/calamares/calamares/wiki/Use-Guide)
+### Building (Vanilla)
+
+Calamares has some [generic user documentation](https://calamares.io/docs/users-guide/)
 for end-users, but most of what we have is for distro developers.
 
 ## Getting Calamares
@@ -37,14 +51,14 @@ 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++14, CMake-built application.
-The dependencies are explainged in [CONTRIBUTING.md](CONTRIBUTING.md).
+Calamares is a KDE-Frameworks and Qt-based, C++17, CMake-built application.
+The dependencies are explained in [CONTRIBUTING.md](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](https://github.com/calamares/calamares-extensions).
+and an **extensions** repository ([Calamares extensions](https://github.com/calamares/calamares-extensions)).
 
 Contributions to code, modules, documentation, the wiki and the website are all welcome.
 There is more information in the [CONTRIBUTING.md](CONTRIBUTING.md) file.
@@ -54,8 +68,14 @@ There is more information in the [CONTRIBUTING.md](CONTRIBUTING.md) file.
 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 on old-school IRC
-(no registration required). Responsiveness is best during the day
-in Europe, but feel free to idle.
-
-[![Visit our IRC channel](https://kiwiirc.com/buttons/webchat.freenode.net/calamares.png)](https://webchat.freenode.net/?channel=#calamares?nick=guest|)
+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.
+
+* [![Join us on Matrix](https://img.shields.io/badge/Matrix-%23calamares:kde.org-blue)](https://webchat.kde.org/#/room/%23calamares:kde.org)
+* [![Chat on IRC](https://img.shields.io/badge/IRC-Libera.Chat%20%23calamares-green)](https://kiwiirc.com/client/irc.libera.chat/#calamares)