Merge branch 'readmeLin' of dan/ui into master

README.md

@@ -8,20 +8,32 @@ This codebase provides a graphical user interface for Desktop and Android for [C
  
  If you discover a security issue, please log an issue above, or email team@cwtch.im.
 
-# Compiling & Running
+# Running
+
+# Compiling
+The UI is built using QT so you will need the development libraries and tools for your OS. Currently we are using QT 5.13.0
+
 This code relies on [therecipe/qt](https://github.com/therecipe/qt) before getting started consult the [Installation](https://github.com/therecipe/qt/wiki/Installation) and [Getting Started](https://github.com/therecipe/qt/wiki/Getting-Started) documentation to get that up and running. It will make building this much easier.
 
-## Desktop
-    qtdeploy build desktop
-    ./deploy/linux/ui.sh -local -debug 2>&1 | grep -v 'Detected anchors on an item that is managed by a layout.'
+We are aiming to use Go module support for versioning but it has some issues working with therecipe/qt so we aren't there yet. For now build with GO111MODULE=off using just the GOPATH for dependancies.
 
+## Linux 
 
-The -local and -debug flags are helpful when developing.
+    go get -d
+    qtdeploy build linux
+    ./deploy/linux/ui -local -debug 2>&1 | grep -v 'Detected anchors on an item that is managed by a layout.'
+
+The -debug flag increases the logging level.
+
+The -local flag means the binary should use the local copies of QML files instead of the compiled ones allowing for more rapid UI development. 
+
+The grep statement filters out some QML noise.
 
 ## Android
 
 We supply an arm-pie version of tor in `android/libs/armeabi-v7a` with the name `libtor.so`
 
+    go get -d
     qtdeploy -docker build android
     adb install deploy/android/build-debug.apk
 
@@ -38,11 +50,15 @@ We supply an arm-pie version of tor in `android/libs/armeabi-v7a` with the name
     - `go get -u -v github.com/therecipe/qt/cmd/...`
     - `qtsetup` (Can take around an hour?)
 
-If all that is done, then check out cwtch.im/ui and run `qtdeploy` in the root of it.
+If all that is done, then check out cwtch.im/ui
 
-Currently you will need to manually run tor first before running cwtch.im/ui. Use the included tor and torrc file: `tor -f torrc`
+    go get -d
+    qtdeploy
+    deploy/windows/ui
 
-# Development
+Currently if you do not have Tor running Cwtch will start tor for you, which will open a dos console window. We are working to hide this in the future.
+
+# Contributing
 
 ## Translations