From fea99f0985e8f319dfe1577a502a8a6e92bab79a Mon Sep 17 00:00:00 2001
From: Maxim Slipenko <no-reply@maxim.slipenko.com>
Date: Tue, 3 Oct 2023 20:49:35 +0300
Subject: [PATCH] =?UTF-8?q?chore:=20=D0=B4=D0=BE=D0=B1=D0=B0=D0=B2=D0=BB?=
 =?UTF-8?q?=D0=B5=D0=BD=20=D1=84=D0=B0=D0=B9=D0=BB=20README.md=20(#69)?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Closes #26.

---------

Co-authored-by: codacy-production[bot] <61871480+codacy-production[bot]@users.noreply.github.com>
---
 README.md | 56 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 56 insertions(+)

diff --git a/README.md b/README.md
index e69de29..5bbb501 100644
--- a/README.md
+++ b/README.md
@@ -0,0 +1,56 @@
+# Statapp
+
+![Release info](https://img.shields.io/github/v/release/shizand/statapp)
+![Python version](https://img.shields.io/badge/python-3.8-blue.svg)
+![Codacy grade](https://img.shields.io/codacy/grade/c4e370d74a8a4575b79afa8b9b74d130)
+![License info](https://img.shields.io/github/license/shizand/statapp)
+
+Автоматизированное программное средство по статистическому анализу и регрессионному моделированию. Является идейным продолжателем программы STAT.exe (Produced by Reutov V.N., Donetsk University, 1990)
+
+Разработано двумя студентами ФГБОУ ВО «ДонНТУ» для своего университета.
+
+## Поддерживаемые ОС и архитектуры
+
+В теории, должно работать на любой архитектуре и ОС где запускается Python 3.8 и есть Qt 5.
+
+Работоспособность проверена на x64:
+
+* на Windows 7, 10;
+* на ALT Linux 10.2.
+
+## Установка
+
+Существует два варианта statapp и statapp-onefile. Различия в том, что onefile версия поставляется одним единственным бинарным файлом. На Windows системах с включенным антивирусом это может вызывать [некоторые проблемы](https://qna.habr.com/q/988553).
+
+### Готовые двоичные файлы
+
+[Скачайте архив](https://github.com/shizand/statapp/releases) под вашу платформу и распакуйте в любом месте.
+
+### Сборка из исходников
+
+В этом проекте используется [poetry](https://python-poetry.org/).
+
+```bash
+poetry install
+poetry run pyinstaller statapp.spec # или poetry run pyinstaller stat-onefile.spec
+```
+
+## Использование
+
+<!-- TODO -->
+
+## Чем я могу помочь проекту?
+
+* [Сообщить об ошибке](https://github.com/shizand/statapp/issues/new?labels=%D0%B1%D0%B0%D0%B3)
+
+## Исходный код
+
+Исходный код доступен на [GitHub](https://github.com/shizand/statapp).
+Также есть зеркала:
+
+* [GitFic](https://gitflic.ru/project/shizand/statapp);
+* [Gitea сервер](https://git.slipenko.com/shizand/statapp).
+
+## Лицензия
+
+[GPL-3.0 © Maxim Slipenko, Eugene Lazurenko.](https://github.com/shizand/statapp/blob/main/LICENSE)