From 77d2e2135e4481c334c8e42b4cf224889367abaf Mon Sep 17 00:00:00 2001 From: Gormogon Date: Fri, 20 Feb 2015 20:10:09 -0500 Subject: [PATCH] New README Format --- README.md | 57 +++++++++++++++++++++++-------------------------------- 1 file changed, 24 insertions(+), 33 deletions(-) diff --git a/README.md b/README.md index 66e700b15..79e0c681b 100644 --- a/README.md +++ b/README.md @@ -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 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/) +| [Report a Bug](http://calamares.io/bugs/) | Freenode (IRC): #calamares | +|:-----------------------------------------:|:--------------------------:| ### Dependencies -* CMake >= 2.8.12 -* Qt >= 5.3 -* yaml-cpp >= 0.5.1 -* Python >= 3.3 -* Boost.Python >= 1.55.0 - -Additional dependencies, only for the partitioning module: -* extra-cmake-modules -* kconfig (part of KF5) -* solid (part of KF5) -* kcoreaddons (part of KF5) -* ki18n (part of KF5) +| Main | Partitioning Module | +|:----:|:-------------------:| +| CMake >= 2.8.12 | extra-cmake-modules | +| Qt >= 5.3 | kconfig (part of KF5) | +| yaml-cpp >= 0.5.1 | solid (part of KF5) | +| Python >= 3.3 | kcoreaddons (part of KF5) | +| Boost.Python >= 1.55.0 | ki18n (part of KF5) | ### Building ``` @@ -32,16 +23,16 @@ $ cmake -DCMAKE_BUILD_TYPE=Debug .. $ make ``` -### Design notes -Calamares is currently split as follows: -* libcalamares - the backend library, - * only depends on QtCore, yaml-cpp, Python and Boost.Python, - * provides a job queue and generic jobs, - * comes with 3 job interfaces: C++, Python and process (the latter is very limited); -* libcalamaresui - the frontend library, - * same dependencies as libcalamares, plus QtWidgets and other Qt modules, - * comes with a module loading system, for different kinds of plugins, - * 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; -* calamares - the main executable, - * a thin wrapper around libcalamaresui, starts up and plugs together all the parts. +### Design Notes +__Calamares is currently split as follows__: +1. __libcalamares__ - The back-end library. + * Only depends on QtCore, yaml-cpp, Python and Boost.Python. + * Provides a job queue and generic jobs. + * Comes with 3 job interfaces: C++, Python and process (the latter is very limited). +2. __libcalamaresui__ - The front-end library. + * Same dependencies as libcalamares, plus QtWidgets and other Qt modules. + * Comes with a module loading system, for different kinds of plugins. + * Themeable, so branding can be done easily (plugin-based, TBD). + * Presents a bunch of pages in a scripted order, enqueues jobs in the back-end library. +3. __calamares__ - The main executable. + * A thin wrapper around libcalamaresui; starts up and plugs together all the parts.