aiden
/
calamares
mirror of https://github.com/cutefishos/calamares
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Merge pull request #196 from Gormogon/master

Browse Source 
README Reformat
main
Teo Mrnjavac 11 years ago
parent 17ed9a1227 40ceca5a85
commit 0d4cab75c5
2 changed files with 25 additions and 38 deletions
Show Stats Download Patch File Download Diff File

8
HACKING.md
Unescape Escape View File

@ -1,10 +1,6 @@
Hacking on Calamares Hacking on Calamares
==================== ====================
Join #calamares on Freenode.
Patches go to [github.com/calamares](https://github.com/calamares/calamares).
Licensing 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. 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. * Use CamelCase for everything.
* Local variables should start out with a lowercase letter. * 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 class member variables with `m_`, e.g. `m_queue`.
* Prefix static member variables with `s_`, e.g. `s_instance`. * Prefix static member variables with `s_`, e.g. `s_instance`.
* Functions are named in the Qt style, like Java's, without the 'get' prefix. * 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 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]). 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 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 object, and use const variables. It improves safety, and also makes it easier to

55
README.md
Unescape Escape View File

@ -1,26 +1,17 @@
Calamares ### Calamares: Distribution-Independent Installer Framework
========= ---------
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/) | [Contribute](https://github.com/calamares/calamares/blob/master/HACKING.md) | 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.

Write Preview
Loading…
Cancel
Save