Update the documentations

Author: u-235

INSTALL.md

@@ -0,0 +1,96 @@
+Building GCodeWorkShop
+======================
+
+GCodeWorkShop is written in C++ using the Qt5 framework. In general,
+the following steps are needed to build it:
+
+- Install the C++11 compiler supported by [Qt SDK][1]. You should also
+  install the make utility.
+- Install Qt utilities such as qmake, moc, lrelease and the resource packer.
+- Install the Qt5 framework with version 5.6 or higher.
+- Obtain and unzip the GCodeWorkShop source code.
+- Create a build folder and navigate to it.
+- Run qmake specifying the path to GCodeWorkShop sources.
+- Run make to build the application.
+
+
+Building in Debian
+------------------
+
+Install the following packages.
+
+```
+apt update
+apt install build-essential qtbase5-dev qttools5-dev-tools libqt5serialport5-dev
+```
+
+Switch to the folder with sources. Now you can either build the application
+step by step or use the script to automatically build the application and
+create an installation package.
+
+
+### Step-by-step build
+
+```sh
+mkdir -p build
+cd build
+qmake -r ..
+make lrelease -j $(nproc)
+qmake -r ..
+make -j $(nproc)
+```
+
+
+### Automatically build and create an package
+
+Run script:
+
+```sh
+install/deb-build.sh
+```
+
+The script creates a .deb package in the current folder and does not require
+root privileges.
+
+
+Building in windows with MSYS2
+------------------------------
+
+Install the following packages.
+
+```sh
+pacman -Syu
+pacman -S make mingw-w64-x86_64-gcc mingw-w64-x86_64-nsis \
+    mingw-w64-x86_64-qt5-tools mingw-w64-x86_64-qt5-translations \
+    mingw-w64-x86_64-qt5-base mingw-w64-x86_64-qt5-serialport
+```
+
+Switch to the folder with sources. Now you can either build the application
+step by step or use the script to automatically build the application and
+create an installer.
+
+
+### Step-by-step build
+
+```sh
+mkdir -p build
+cd build
+qmake -r ..
+make lrelease -j $(nproc)
+qmake -r ..
+make -j $(nproc)
+```
+
+
+### Automatically build and create an installer
+
+Run script:
+
+```sh
+install/win-msys2-build.sh
+```
+
+The script creates a .exe installer in the current folder.
+
+
+[1]: https://doc.qt.io/qt-5/supported-platforms.html "Qt5 doc: supported platforms"

README.md

@@ -4,6 +4,11 @@ GCodeWorkShop
 This is a fork of [EdytorNC](https://github.com/artur3/EdytorNC), a text editor
 for CNC programmers.
 
+- [Some features](#some-features)
+- [Some shotcuts](#some-shotcuts)
+- [Getting GCodeWorkShop](#getting-gcodeworkshop)
+- [Command line options](#command-line-options)
+
 
 Some features
 ------------
@@ -49,35 +54,16 @@ Some shotcuts
   `SQRT(x)` `SQR(x)` `ABS(x)` `TRUNC(x)` `PI`
 
 
+Getting GCodeWorkShop
+---------------------
+
+On the [release page](https://github.com/GCodeProjects/GCodeWorkShop/releases/latest)
+you can find binary builds for Debian, Ubuntu and Windows. For building the
+application yourself, the [build instructions](INSTALL.md) may be useful.
+
+
 Command line options
 ------------------
 
 - open file -> `gcodeworkshop file.nc`
 - diff two files -> `gcodeworkshop -diff file1.nc file2.nc`
-
-
-Compile GCodeWorkShop
--------------------
-
-
-### Ubuntu
-
-run terminal
-```
-sudo apt install qt5-default qtbase5-dev-tools qt5-qmake
-cd ~
-git clone https://github.com/GCodeProjects/GCodeWorkShop
-cd GCodeWorkShop
-qmake -r [CONFIG+=debug] [PREFIX=/usr/ | PREFIX=~/.local/bin/]
-make
-make lrelease
-```
-
-
-### Windows
-
-- [Install Qt5](http://www.qt.io/download-open-source)
-- download latest version of GCodeWorkShop [source files](https://github.com/GCodeProjects/GCodeWorkShop/archive/master.zip)
-- unzip downloaded file
-- open gcodeworkshop.pro in Qt Creator
-- press Ctrl+R