aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorlink2xt <link2xt@testrun.org>2021-08-29 17:52:27 +0000
committerlink2xt <link2xt@testrun.org>2021-08-29 17:52:27 +0000
commit43a9871f335da001a73dc1b7d9d890c1abc61b19 (patch)
tree53fe415210729ab49330281cfda50468ec9eae1d
parent4d051bc35611fa5b75865769df7a512d90a13c65 (diff)
downloadkdeltachat-43a9871f335da001a73dc1b7d9d890c1abc61b19.tar.gz
kdeltachat-43a9871f335da001a73dc1b7d9d890c1abc61b19.zip
Update README to de-emphasize kdesrc-build
-rw-r--r--README.md81
1 files changed, 42 insertions, 39 deletions
diff --git a/README.md b/README.md
index 4263106..d33a9f1 100644
--- a/README.md
+++ b/README.md
@@ -8,29 +8,10 @@ KDeltaChat build depends on
[libdeltachat](https://github.com/deltachat/deltachat-core-rust/),
Kirigami framework and several QML modules.
-## kdesrc-build
-
-It's recommended to build KDeltaChat with [kdesrc-build](https://kdesrc-build.kde.org/).
-This allows to avoid installing `libdeltachat` system-wide and use
-upstream Kirigami instead of usually outdated packaged versions.
-
-Install it with:
-```
-mkdir -p ~/kde/src
-cd ~/kde/src
-git clone https://invent.kde.org/sdk/kdesrc-build.git
-cd kdesrc-build
-./kdesrc-build-setup
-./kdesrc-build kirigami
-```
-
-Run
-```
-source ~/.config/kde-env-master.sh
-```
-in your shell to enter `kdesrc-build` environment.
+## libdeltachat
-## Rust
+`libdeltachat` is not packaged for most distributions, so the easiest
+way is to install it system-wide from the source.
Building `libdeltachat` requires Rust.
Install it from https://rustup.rs/ with
@@ -38,22 +19,11 @@ Install it from https://rustup.rs/ with
$ curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- -y --default-toolchain none
```
-## libdeltachat
-
-If you are using [`kdesrc-build`](https://kdesrc-build.kde.org/),
-add module into `~/.kdesrc-buildrc` as follows
-```
-module deltachat
- repository https://github.com/deltachat/deltachat-core-rust.git
-end module
-```
-Then build `libdeltachat` with `kdesrc-build deltachat`.
-
-Alternatively, if you are not using `kdesrc-build`, install `libdeltachat` system-wide:
+Then, clone the source, build `libdeltachat` and install it:
```
$ git clone https://github.com/deltachat/deltachat-core-rust.git
$ cd deltachat-core-rust
-$ cmake -B build .
+$ cmake -B build . -DCMAKE_INSTALL_PREFIX=/usr
$ cmake --build build
$ sudo cmake --install build
```
@@ -116,10 +86,8 @@ zypper install -y libqt5-qtbase-devel libQt5QuickControls2-devel libqt5-quickcon
## Kirigami
-Build Kirigami with `kdesrc-build kirigami`.
-
-Alternatively, if you are not using `kdesrc-build`, install system package for Kirigami,
-such as `kirigami2-dev` on Debian or Ubuntu, `kirigami2` on Arch Linux or `kirigami2-devel` on OpenSUSE.
+Install system package for Kirigami, such as `kirigami2-dev` on Debian
+or Ubuntu, `kirigami2` on Arch Linux or `kirigami2-devel` on OpenSUSE.
# Building
@@ -134,6 +102,41 @@ cmake --build build
Run `build/kdeltachat`. Import existing account from backup or setup a
new one. Start IO in the main menu to connect.
+# Using kdesrc-build
+
+If your distribution does not package recent enough versions of the
+Kirigami framework, or you don't want to install `libdeltachat`
+system-wide, you can use [kdesrc-build](https://kdesrc-build.kde.org/).
+
+Install it with:
+```
+mkdir -p ~/kde/src
+cd ~/kde/src
+git clone https://invent.kde.org/sdk/kdesrc-build.git
+cd kdesrc-build
+./kdesrc-build-setup
+./kdesrc-build kirigami
+```
+
+Run
+```
+source ~/.config/kde-env-master.sh
+```
+in your shell to enter `kdesrc-build` environment.
+
+To build `libdeltachat` with `kdesrc-build`,
+add module into `~/.kdesrc-buildrc` as follows
+```
+module deltachat
+ repository https://github.com/deltachat/deltachat-core-rust.git
+end module
+```
+Then build `libdeltachat` with `kdesrc-build deltachat`.
+
+Build Kirigami with `kdesrc-build kirigami`.
+
+Then build `kdeltachat` as described above.
+
# Troubleshooting
## Button icons are replaced with black rectangles