From 77d2e2135e4481c334c8e42b4cf224889367abaf Mon Sep 17 00:00:00 2001 From: Gormogon Date: Fri, 20 Feb 2015 20:10:09 -0500 Subject: [PATCH 1/6] 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. From e6f18c10ec6e9792b70852e500a82c19132d8ae5 Mon Sep 17 00:00:00 2001 From: Gormogon Date: Fri, 20 Feb 2015 20:12:00 -0500 Subject: [PATCH 2/6] Fixed Format --- README.md | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 79e0c681b..fbce89be0 100644 --- a/README.md +++ b/README.md @@ -25,14 +25,14 @@ $ make ### 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. + 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. From ec08d0405cb559fbe168b579c3a8b978351de18e Mon Sep 17 00:00:00 2001 From: Gormogon Date: Fri, 20 Feb 2015 20:13:09 -0500 Subject: [PATCH 3/6] Remove Bold --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index fbce89be0..c1a74fa40 100644 --- a/README.md +++ b/README.md @@ -24,7 +24,7 @@ $ make ``` ### Design Notes -__Calamares is currently split as follows__: +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. From b7327b3693d887e1144a0c4b3d89c1e4d48a7730 Mon Sep 17 00:00:00 2001 From: Gormogon Date: Fri, 20 Feb 2015 20:22:27 -0500 Subject: [PATCH 4/6] Moving Build Status --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index c1a74fa40..c831699da 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@ -### Calamares: Distribution-Independent Installer Framework [![Build Status](http://calamares.io/ci/buildStatus/icon?job=calamares-master)](http://calamares.pangea.pub/ci/job/calamares-master/) +### Calamares: Distribution-Independent Installer Framework --------- -| [Report a Bug](http://calamares.io/bugs/) | Freenode (IRC): #calamares | -|:-----------------------------------------:|:--------------------------:| +| [![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 | Main | Partitioning Module | From 64c11134eb85250c85436b324bc8b34c3f609029 Mon Sep 17 00:00:00 2001 From: Gormogon Date: Fri, 20 Feb 2015 20:38:23 -0500 Subject: [PATCH 5/6] Add Contribute Link --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index c831699da..81ec06621 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@ ### Calamares: Distribution-Independent Installer Framework --------- -| [![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 | -|:-----------------------------------------:|:--------------------------:|:--------------------------:| +| [![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/) | [Contribute](https://github.com/calamares/calamares/blob/master/HACKING.md) | Freenode (IRC): #calamares | +|:-----------------------------------------:|:--------------------------:|:--------------------------:|:--------------------------:| ### Dependencies | Main | Partitioning Module | From 40ceca5a85c604e593529fd807ce70050dbcf881 Mon Sep 17 00:00:00 2001 From: Gormogon Date: Fri, 20 Feb 2015 20:46:16 -0500 Subject: [PATCH 6/6] Update HACKING.md Fixed typo and removed section that would be redundant with the new README. --- HACKING.md | 8 ++------ 1 file changed, 2 insertions(+), 6 deletions(-) diff --git a/HACKING.md b/HACKING.md index df1d61a39..4adcc4d43 100644 --- a/HACKING.md +++ b/HACKING.md @@ -1,10 +1,6 @@ Hacking on Calamares ==================== -Join #calamares on Freenode. - -Patches go to [github.com/calamares](https://github.com/calamares/calamares). - Licensing --------- Calamares is released under the terms of the GNU GPL, version 3 or later. Every source file must have a license header, with a list of copyright holders and years. @@ -78,7 +74,7 @@ Naming ------ * Use CamelCase for everything. * Local variables should start out with a lowercase letter. -* Class names are captialized +* Class names are capitalized * Prefix class member variables with `m_`, e.g. `m_queue`. * Prefix static member variables with `s_`, e.g. `s_instance`. * Functions are named in the Qt style, like Java's, without the 'get' prefix. @@ -128,7 +124,7 @@ The use of `nullptr` is preferred over the use of `0` or `NULL`. For Qt containers it is better to use Qt's own `foreach`. For all other containers, the range-based `for` syntax introduced with C++11 is preferred ([see this blog post][1]). -When reimplementing a virtual method, always add the `override` keyword. +When re-implementing a virtual method, always add the `override` keyword. Try to keep your code const correct. Declare methods const if they don't mutate the object, and use const variables. It improves safety, and also makes it easier to