From a716e8e5bfc4366e9c4b7073f3d3325dee8ae5b1 Mon Sep 17 00:00:00 2001
From: Andrew nuark G <mrcluster@ya.ru>
Date: Sun, 10 Jan 2021 22:27:18 +0700
Subject: [PATCH] Update README

---
 README.md | 72 ++++++++++++++++++++++++++++++++++++++++++++-----------
 1 file changed, 58 insertions(+), 14 deletions(-)

diff --git a/README.md b/README.md
index b59d8a4..ac02dc9 100644
--- a/README.md
+++ b/README.md
@@ -1,17 +1,61 @@
-# Информационная система «Морской транспорт». 
+# Information System "Sea transport" 
 
-### Состав сущностей
-	суда – номер судна, порт приписки, список грузов, размер свободного места в грузовых отсеках
-	груз – идентификатор, количество, пункт доставки
-	пункт доставки – название, список складов
-	склад – номер склада, количество свободного места
+### IS Entities
+	- Vessels 
+		– ID
+		- harbor
+		- cargo
+		- capacity
+	- Cargo
+		- ID
+		- volume
+		- delivery point
+	- Delivery point (Harbor)
+		- ID
+		- title
+		- storages
+	- Storage
+		- ID
+		- capacity
 
-### Операции, исполняемые системой
-	просмотр списка судов
-	перемещение грузов из судов в различных пунктах в склады
-	просмотр списка грузов для каждого склада и загрузку судов
+### Operations
+	- Vessels listing
+	- Cargo movement
+	- Cargo listing
 
-### Группы пользователей
-	администратор
-	диспетчер
-	капитан
+### Usergroups
+	- Administrator
+	- Dispatcher
+	- Skipper
+
+
+# Documentation
+
+Internal documentation generated with Doxygen can be found in [here](./sea_transport/documentation/)
+
+
+# Code Quality
+
+I am not usig any particular common code conventions, instead I have created my own, based on my specific views and inspirations. Something from Apache's C++ CC, something from Python. In general, I am aimed to write easilly readable? self-documenting code.
+
+
+# How to build 
+
+## Prequisites:
+
+- QtCreator 4.13+
+- QtFramework at least 5.15
+- MinGW v81 x64 (I am developed and builded with it, you can use MSVC if it'll compile)
+
+## Step-by step
+
+1. Open project in QtCreator
+	1. If needed - reconfigure project to match your setup
+2. Set build type to release
+3. Click `build` button
+4. Locate generated binaries - we will need `{build name}.exe` file
+5. Open you shell (I am using OGPowershell, not PSCore)
+	1. Locate file `windeployqt.exe` in your Qt installation dir 
+	> you can do so by using something like `gci -Path {QtPath} -Recurse -Include windeployqt.exe`
+6. Execute command `{path to windeployqt.exe}\windeployqt.exe {path to generated exe}\{build name}.exe`
+7. If everything done right - you will get all the static libs to run your build on any computer without Qt installation