napcok/calamares
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

New README Format

Browse Source
This commit is contained in:
Gormogon 2015-02-20 20:10:09 -05:00
parent 6ed8b1e4a4
commit 77d2e2135e
1 changed files with 24 additions and 33 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

57
README.md
View File

@ -1,26 +1,17 @@
Calamares ### Calamares: Distribution-Independent Installer Framework [![Build Status](http://calamares.io/ci/buildStatus/icon?job=calamares-master)](http://calamares.pangea.pub/ci/job/calamares-master/)
========= ---------
Distribution-independent installer framework | [Report a Bug](http://calamares.io/bugs/) | Freenode (IRC): #calamares |
|:-----------------------------------------:|:--------------------------:|
[Report bugs here](http://calamares.io/bugs/)
[![Build Status](http://calamares.io/ci/buildStatus/icon?job=calamares-master)](http://calamares.pangea.pub/ci/job/calamares-master/)
### Dependencies ### Dependencies
* CMake >= 2.8.12 | Main | Partitioning Module |
* Qt >= 5.3 |:----:|:-------------------:|
* yaml-cpp >= 0.5.1 | CMake >= 2.8.12 | extra-cmake-modules |
* Python >= 3.3 | Qt >= 5.3 | kconfig (part of KF5) |
* Boost.Python >= 1.55.0 | yaml-cpp >= 0.5.1 | solid (part of KF5) |
| Python >= 3.3 | kcoreaddons (part of KF5) |
Additional dependencies, only for the partitioning module: | Boost.Python >= 1.55.0 | ki18n (part of KF5) |
* extra-cmake-modules
* kconfig (part of KF5)
* solid (part of KF5)
* kcoreaddons (part of KF5)
* ki18n (part of KF5)
### Building ### Building
``` ```
@ -32,16 +23,16 @@ $ cmake -DCMAKE_BUILD_TYPE=Debug ..
$ make $ make
``` ```
### Design notes ### Design Notes
Calamares is currently split as follows: __Calamares is currently split as follows__:
* libcalamares - the backend library, 1. __libcalamares__ - The back-end library.
* only depends on QtCore, yaml-cpp, Python and Boost.Python, * Only depends on QtCore, yaml-cpp, Python and Boost.Python.
* provides a job queue and generic jobs, * Provides a job queue and generic jobs.
* comes with 3 job interfaces: C++, Python and process (the latter is very limited); * Comes with 3 job interfaces: C++, Python and process (the latter is very limited).
* libcalamaresui - the frontend library, 2. __libcalamaresui__ - The front-end library.
* same dependencies as libcalamares, plus QtWidgets and other Qt modules, * Same dependencies as libcalamares, plus QtWidgets and other Qt modules.
* comes with a module loading system, for different kinds of plugins, * Comes with a module loading system, for different kinds of plugins.
* themeable so branding can be done easily (plugin-based, TBD), * Themeable, so branding can be done easily (plugin-based, TBD).
* presents a bunch of pages in a scripted order, enqueues jobs in the backend library; * Presents a bunch of pages in a scripted order, enqueues jobs in the back-end library.
* calamares - the main executable, 3. __calamares__ - The main executable.
* a thin wrapper around libcalamaresui, starts up and plugs together all the parts. * A thin wrapper around libcalamaresui; starts up and plugs together all the parts.