Selaa lähdekoodia

Обновить 'README.md'

EgorPigalev 1 vuosi sitten
vanhempi
commit
59b7ad687a
1 muutettua tiedostoa jossa 23 lisäystä ja 1 poistoa
  1. 23 1
      README.md

+ 23 - 1
README.md

@@ -1,2 +1,24 @@
-# prob
+# Программа для ведения учёта товаров
+Данная программа предназначена для ведения учёта товаров, а именно редактирование данных, их добавление и удаление.
+## Начало работы
+Для непосредственного начала работы следует скачать данный репозиторий с Gogs. Для этого необходимо проделать следующие действия:
++ Открыть репозиторий на сайте Gogs;
++ Нажать на иконку скачать
++ Выбрать пункт "ZIP"
 
+### Необходимые условия
+Для установики данного программного обеспечения необходимо наличие программы ***Android Studio***.
+Для работы с данной прогораммой необходимо наличие компьютера, удовлетовряющего минимальным требования среды разработки "Android Studio", ознакомится с которыми можно на официальном сайте.
+### Установка
+Для установки данного программного обеспечения необходимо необходимо проделать следующие действия:
+1. Взять скаченую архивную копию программы
+2. Разархивировать архив:
+   + нажать ПКМ на архив;
+   + выбрать нужный архиватор;
+   + нажать распаковать в папку;
+3. Запустить проект спомощью программы ***Android Studio***.
+## Основные механизмы
+Данный программный продукт имеет клиент-серверную архитектуру. База данных рассположена на сервере, а сама программа находится на клиентских компьютерах. Для взаимодейтсвия сервера с клиентом реализован проект Web Api, который позволяет двум программным компонентам взаимодействовать друг с другом, используя набор определений и протоколов. Для передачи данных в мобильное приложение был использован формат JSON, так как он хорош при работе с медленным интернетом. Для контроля утечки информации в программе предусмотрена авторизация. Для редактирования БД пользователь должен авторизироваться, если же необходим только просморт, то можно войти как гость.
+## Авторы
+Люди которые принимали участие в разработке проекта:
+* **Пигалев Егор** - [EgorPigalev](http://gogs.ngknn.ru:3000/EgorPigalev)