From ce34f05b6d9398d030ad21591b75a64499c383f3 Mon Sep 17 00:00:00 2001
From: EndrII <EndrIIMail@gmail.com>
Date: Sun, 21 Jun 2020 17:33:22 +0300
Subject: [PATCH] added quick guide

---
 Home.md       |  1 +
 quickguide.md | 81 +++++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 82 insertions(+)
 create mode 100644 quickguide.md

diff --git a/Home.md b/Home.md
index 3df6c02..16be1e2 100644
--- a/Home.md
+++ b/Home.md
@@ -8,6 +8,7 @@
 * [Description CQtDeployer](https://github.com/QuasarApp/CQtDeployer/wiki/Description)
 * [Options](https://github.com/QuasarApp/CQtDeployer/wiki/Options)
 * [Guide](https://github.com/QuasarApp/CQtDeployer/wiki/Guide)
+* [Quick guide](quickguide.md)
 * [Build and Install](https://github.com/QuasarApp/CQtDeployer/wiki/Build-and-Install)
 * [Example](https://github.com/QuasarApp/CQtDeployer/tree/master/examples/TestQMLWidgets)
 * [Deploy file](https://github.com/QuasarApp/CQtDeployer/wiki/DeployConfigFileEn)
diff --git a/quickguide.md b/quickguide.md
new file mode 100644
index 0000000..1979b53
--- /dev/null
+++ b/quickguide.md
@@ -0,0 +1,81 @@
+
+
+How to deploy project with cqtdeployer.
+
+1. First one you need to install cqtdeployer into your platform
+
+    * Snap (14 more linux destributions):
+    ```
+    sudo snap install cqtdeployer
+    ```
+    Or 
+
+    Install from snap store and add all requirement permissions.
+
+    [![Download from Snap Store](https://snapcraft.io/static/images/badges/ru/snap-store-black.svg)](https://snapcraft.io/cqtdeployer)
+
+    * Other linux [LinuxInstaller.run][1].
+    ```
+    chmod +x LinuxInstaller.run
+    ./LinuxInstaller.run
+    ```
+
+    * Windows [installer][1]
+
+2. Build your project on release mode.
+3. Deploy yor executable file.
+
+    * For Linux systems:
+    ``` bash
+    cqtdeployer -bin myexecutable
+    ```
+
+    * For Windows systems:
+    ``` bash
+    cqtdeployer -bin myexecutable.exe -qmake C:/Qt/5.15.0/min_gw/bin/qmake.exe
+    ```
+
+    * For crossplatform build (Linux -> Windows)
+    ``` bash
+    cqtdeployer -bin myexecutable.exe -qmake ~/crossbuildet-Qt/5.15.0/min_gw/bin/qmake.exe
+    ```
+
+## Extra options
+
+If you use extra libraries. just add path for cqtdeployer to used libs.
+``` bash
+cqtdeployer -bin myexecutable -libDir /PathToMyExtraLibs 
+```
+
+If you want find libraryes recursive from libDir path, just add recursiveDepth option.
+``` bash
+cqtdeployer -bin myexecutable -libDir /PathToMyExtraLibs -recursiveDepth 5
+```
+
+If you application use qml, just add qmlDir option
+``` bash
+cqtdeployer -bin myexecutable -libDir /PathToMyExtraLibs -recursiveDepth 5 -qmlDir /path/to/my/qml/sources
+```
+
+If you want create simple installer for you application just add qif option.
+```
+cqtdeployer -bin myexecutable -libDir /PathToMyExtraLibs -recursiveDepth 5 -qmlDir /path/to/my/qml/sources qif
+```
+
+If you use system libraries from system PATH, just add deploySystem option. 
+
+#### Warning: snap version do not have permision to system files. To deploy system libraries use the cqtdeployer version from the [installer][1]
+
+```
+cqtdeployer -bin myexecutable -libDir /PathToMyExtraLibs -recursiveDepth 5 -qmlDir /path/to/my/qml/sources qif deploySystem
+```
+
+
+### If you have any problems with use cqtdeployer then ask you questions on the official github issues [page][2].
+
+### For more options of CQtDeploye see oficial [documentation][3].
+
+[1]: https://github.com/QuasarApp/CQtDeployer/releases
+[2]: https://github.com/QuasarApp/CQtDeployer/issues
+[3]: https://github.com/QuasarApp/CQtDeployer/wiki/Options
+