From 8a7e1401634e056ee30a92519de757b81356bd6c Mon Sep 17 00:00:00 2001
From: miruka <miruka@disroot.org>
Date: Fri, 30 Aug 2019 17:05:22 -0400
Subject: [PATCH] Improve README instructions

---
 README.md | 18 ++++++++++++++----
 TODO.md   |  5 ++++-
 2 files changed, 18 insertions(+), 5 deletions(-)

diff --git a/README.md b/README.md
index 7c1aa4ff..1ae2ec34 100644
--- a/README.md
+++ b/README.md
@@ -2,7 +2,7 @@
 
 ## Dependencies setup
 
-Outside of pip/github:
+From your distribution's package manager, install:
 
 Qt 5.12+, including:
 - qt5-declarative-devel
@@ -17,9 +17,13 @@ Qt 5.12+, including:
 - python3-devel
 - olm-python3 >= 3.1
 
-Make sure the right version of Qt is used:
+Make sure that the right version of Qt is selected and compiler flags are
+correctly set:
 
     export QT_SELECT=5
+    export CFLAGS="-march=native -O2 -pipe"
+    export CXXFLAGS="$CFLAGS"
+    export MAKEFLAGS="$(nproc)"
 
 Install [pyotherside](https://github.com/thp/pyotherside):
 
@@ -28,17 +32,19 @@ Install [pyotherside](https://github.com/thp/pyotherside):
     qmake && make && sudo make install
 
 After this, verify the permissions of the installed plugin files.
+To ensure that they're correctly set:
 
+    sudo chmod -R 755 /usr/lib/qt5/qml/io
     sudo chmod 644 /usr/lib/qt5/qml/io/thp/pyotherside/*
     sudo chmod 755 /usr/lib/qt5/qml/io/thp/pyotherside/*.so
 
-Install the dependencies from Pypi:
+Install the Python 3 dependencies from Pypi:
 
     pip3 install --user --upgrade \
         Pillow aiofiles appdirs dataclasses filetype hsluv html_sanitizer \
         lxml mistune uvloop
 
-Install the dependencies from Github:
+Install the Python 3 dependencies from Github:
 
 [matrix-nio](https://github.com/mirukan/matrix-nio):
 
@@ -53,3 +59,7 @@ Install the dependencies from Github:
     qmake harmonyqml.pro && make && sudo make install
 
 After this if no errors happened, run `harmonyqml`.
+
+If you get a version mismatch error related to cffi, try:
+
+    pip3 install --user --upgrade --force-reinstall cffi
diff --git a/TODO.md b/TODO.md
index b4e9aa3b..52d847ce 100644
--- a/TODO.md
+++ b/TODO.md
@@ -11,9 +11,13 @@
   - When qml syntax highlighting supports ES6 string interpolation, use them
 
 - Fixes
+  - make install
+  - Make uvloop optional
   - Icons on KDE
+  - Distribute fonts
   - Backspace bug
   - Add missing shortcuts to config file
+  - Zoom animation with gradient
 
   - Show error if uploading avatar fails or file is corrupted
 
@@ -91,7 +95,6 @@
 
   - Theming
     - File format
-    - Distribute fonts
     - icons.preferredPack: accept multiple values
     - Find icon packs in user data dir
     - Correctly implement uiScale/fontScale + ctrl+-= keys