summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorTeo Mrnjavac <teo@kde.org>2016-05-11 16:22:33 +0200
committerTeo Mrnjavac <teo@kde.org>2016-05-11 16:22:33 +0200
commitf72e24db4e145e5e335c12a050025b64018a7a63 (patch)
tree1064e360921386dfbc0f8fd73fae386e61a4b796 /README.md
parent9dc2b00ef8e5a519b5b3aa2cab040b671f98392b (diff)
Update README.md
Diffstat (limited to 'README.md')
-rw-r--r--README.md34
1 files changed, 1 insertions, 33 deletions
diff --git a/README.md b/README.md
index 6958ef2c6..1a0de1264 100644
--- a/README.md
+++ b/README.md
@@ -36,38 +36,6 @@ Modules:
* squashfs-tools
* rsync
-
-### Deployment
-[__Setting up branding__](https://github.com/calamares/calamares/blob/master/src/branding/README.md)
-
-[__Working with modules__](https://github.com/calamares/calamares/blob/master/src/modules/README.md)
-
-
### Building
-Clone Calamares from GitHub and `cd` into the calamares directory, then:
-```
-$ git submodule init
-$ git submodule update
-$ mkdir build
-$ cd build
-$ cmake -DCMAKE_BUILD_TYPE=Debug ..
-$ make
-```
-
-#### Supported variables for CMake
- * `WITH_PYTHON` - if this is set to false, the Python module interface will not be built. Default is true.
- * `SKIP_MODULES` - takes a space-separated list of module names that should not be built even if present in `src/modules` (e.g. `cmake -DSKIP_MODULES="partition mount umount welcome" ..`). Default is empty.
-### 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.
- * Supports branding components.
- * 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.
+See [wiki](https://github.com/calamares/calamares/wiki) for up to date building and deployment instructions.