calamares/README.md

45 lines
2.1 KiB
Markdown
Raw Normal View History

2015-02-20 17:22:27 -08:00
### Calamares: Distribution-Independent Installer Framework
2015-02-20 17:10:09 -08:00
---------
2014-06-03 13:03:07 -07:00
2015-06-13 09:34:26 -07:00
[![GitHub release](https://img.shields.io/github/release/calamares/calamares.svg)](https://github.com/calamares/calamares/releases)
2015-09-27 03:43:08 -07:00
[![Build Status](https://calamares.io/ci/buildStatus/icon?job=calamares-post_commit)](https://calamares.io/ci/job/calamares-post_commit/)
2017-03-15 10:12:42 -07:00
[![Travis Build Status](https://travis-ci.org/calamares/calamares.svg?branch=master)](https://travis-ci.org/calamares/calamares)
2015-06-13 09:32:16 -07:00
[![Coverity Scan Build Status](https://scan.coverity.com/projects/5389/badge.svg)](https://scan.coverity.com/projects/5389)
2015-06-13 09:34:26 -07:00
[![GitHub license](https://img.shields.io/github/license/calamares/calamares.svg)](https://github.com/calamares/calamares/blob/master/LICENSE)
2015-06-13 09:32:16 -07:00
2017-09-25 07:50:48 -07: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 07:29:07 -07:00
|:-----------------------------------------:|:----------------------:|:-----------------------:|:--------------------------:|:--------------------------:|
2014-10-29 03:57:19 -07:00
2014-06-04 07:47:55 -07:00
### Dependencies
2015-06-11 18:05:16 -07:00
2016-02-24 06:34:09 -08:00
Main:
* Compiler with C++11 support: GCC >= 4.9.0 or Clang >= 3.5.1
* CMake >= 3.2
* Qt >= 5.7
2016-02-24 06:34:09 -08:00
* yaml-cpp >= 0.5.1
* Python >= 3.3 (required for some modules)
* Boost.Python >= 1.55.0 (recommended, or PythonQt; one is required for some modules)
* PythonQt (recommended, or Boost.Python; one is required for some modules)
* extra-cmake-modules >= 5.18 (recommended; required for some modules)
2016-02-24 06:34:09 -08:00
Modules:
* welcome:
* NetworkManager
* UPower (optional, runtime)
2016-02-24 06:34:09 -08:00
* partition:
* extra-cmake-modules
* KF5: KCoreAddons, KConfig, KI18n, KService, KWidgetsAddons
* KPMcore >= 3.3
2016-02-24 06:34:09 -08:00
* bootloader:
* systemd-boot or GRUB
2016-02-24 06:34:09 -08:00
* unpackfs:
* squashfs-tools
* rsync
2016-02-24 06:34:09 -08:00
2014-06-04 07:47:55 -07:00
### Building
2015-08-03 08:58:33 -07: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.