calamares/README.md

39 lines
1.9 KiB
Markdown
Raw Normal View History

2015-02-21 02:22:27 +01:00
### Calamares: Distribution-Independent Installer Framework
2015-02-21 02:10:09 +01:00
---------
2014-06-03 22:03:07 +02:00
2015-06-13 18:34:26 +02:00
[![GitHub release](https://img.shields.io/github/release/calamares/calamares.svg)](https://github.com/calamares/calamares/releases)
2017-03-15 18:12:42 +01:00
[![Travis Build Status](https://travis-ci.org/calamares/calamares.svg?branch=master)](https://travis-ci.org/calamares/calamares)
2015-06-13 18:32:16 +02:00
[![Coverity Scan Build Status](https://scan.coverity.com/projects/5389/badge.svg)](https://scan.coverity.com/projects/5389)
2015-06-13 18:34:26 +02:00
[![GitHub license](https://img.shields.io/github/license/calamares/calamares.svg)](https://github.com/calamares/calamares/blob/master/LICENSE)
2015-06-13 18:32:16 +02:00
2017-09-25 16:50:48 +02:00
| [Report a Bug](https://github.com/calamares/calamares/issues/new) | [Contribute](https://github.com/calamares/calamares/blob/master/ci/HACKING.md) | [Translate](https://www.transifex.com/projects/p/calamares/) | Freenode (IRC): #calamares | [Wiki](https://github.com/calamares/calamares/wiki) |
2016-05-11 16:29:07 +02:00
|:-----------------------------------------:|:----------------------:|:-----------------------:|:--------------------------:|:--------------------------:|
2014-10-29 11:57:19 +01:00
2014-06-04 16:47:55 +02:00
### Dependencies
2015-06-12 03:05:16 +02:00
2016-02-24 15:34:09 +01:00
Main:
* Compiler with C++14 support: GCC >= 5 or Clang >= 3.5.1
* CMake >= 3.3
* Qt >= 5.9
2016-02-24 15:34:09 +01:00
* yaml-cpp >= 0.5.1
* Python >= 3.3 (required for some modules)
* Boost.Python >= 1.55.0 (required for some modules)
* KDE extra-cmake-modules >= 5.18 (recommended; required for some modules;
required for some tests)
* KDE Frameworks KCoreAddons (>= 5.58 recommended)
* PythonQt (optional, deprecated)
2016-02-24 15:34:09 +01:00
Modules:
* Individual modules may have their own requirements;
these are listed in CMake output. Particular requirements (not complete):
* *fsresizer* KPMCore >= 3.3
* *partition* KPMCore >= 3.3
* *users* LibPWQuality (optional)
2016-02-24 15:34:09 +01:00
2014-06-04 16:47:55 +02:00
### Building
2015-08-03 17:58:33 +02:00
See [wiki](https://github.com/calamares/calamares/wiki) for up to date
[building](https://github.com/calamares/calamares/wiki/Develop-Guide)
and [deployment](https://github.com/calamares/calamares/wiki/Deploy-Guide)
instructions.