diff --git a/README.md b/README.md index ac02dc9..b59d8a4 100644 --- a/README.md +++ b/README.md @@ -1,61 +1,17 @@ -# 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 +### Группы пользователей + администратор + диспетчер + капитан