Merge pull request #24 from PeeachPie/readme

readme updated

Author: PeeachPie

README.md

@@ -2,28 +2,114 @@
 
 Цель [коллоквиума](https://docs.google.com/document/d/1Dv_6AIhxg_3ezu6VMcEnMpyfRzgym9l8PmE4ULGfjgM/edit?tab=t.0) - создать систему компьютерной алгебры
 
+### Архитектура проекта
+
+Проект имеет следующую структуру:
+
+```
+.
+├── CMakeLists.txt
+├── src
+│   ├── api
+│   │   └── calculator
+│   │       ├── calculator.cpp
+│   │       └── calculator.hpp
+│   ├── main.cpp
+│   ├── modules
+│   │   ├── numbers
+│   │   │   ├── integer
+│   │   │   │   ├── integer.cpp
+│   │   │   │   └── integer.hpp
+│   │   │   ├── natural
+│   │   │   │   ├── natural.cpp
+│   │   │   │   └── natural.hpp
+│   │   │   └── rational
+│   │   │       ├── rational.cpp
+│   │   │       └── rational.hpp
+│   │   └── polynomial
+│   │       ├── polynomial.cpp
+│   │       └── polynomial.hpp
+│   └── ui
+└── tst
+    ├── CMakeLists.txt
+    ├── test_calculator.cc
+    ├── test_integer.cc
+    ├── test_natural.cc
+    ├── test_polynomial.cc
+    └── test_rational.cc
+```
+
+Рассмотрим ее по порядку.
+
+## src 
+Содержит основную логику проекта:
+- модули
+- апи модулей
+- интерфейс
+
+### src/modules 
+Содержит реализацию модулей.
+Модули разделены по блокам:
+- натуральные числа
+- целые числа
+- рациональные числа
+- полиномы над рациональными числами
+
+Каждый блок содержит `*.hpp` и `*.cpp` файлы с объявлением класса блока и его реализацией соответственно.
+
+- `class Naturals` - Класс натуральных чисел. Использует строку цифр и старший разряд.
+- `class Integer` - Класс целых чисел. Использует натуральное число и знак.
+- `class Rational` - Класс рациональных чисел. Использует целое число в качестве числителя и натуральное в качестве знаменателя.
+- `class Polynomial` - Класс рациональных полиномов. Использует структуру данных "красно-черное дерево" (aka std::map) для хранения рациональных коэфициентов. Это необходимо для эффективной работы с разряженными данными (например `x^n + 1`, где `n` большое число). Максимальная степень многочлена ограничена `INT_MAX = 2^31 - 1`.
+
+### src/api
+Содержит апи для работы с рациональными полиномами. Получает на вход выражение в виде строки (например `(x^2 - 1)/(x - 1)`) и возвращает посчитанное выражение (например `1 * x^1 + 1`).
+
+### src/ui
+Содержит пользовательский интерфейс. Реализован при помощи `Qt6`. Формирует запрос к апи и отображает ответ.
+
+Пример работы:
+![alt text](image.png)
+
+Важно отметить, что калькулятор работает именно с рациональными полиномами, а это значит, что `GCD(5, 10)` может быть равен любому рациональному числу. Договоримся, что ответ будет равен `1`.
+
+## tst
+Содержит более 180 тестов для проверки работы блоков и апи. Все тесты проходят успешно.
+
 ### Сборка и запуск проекта
 
-Перейти в директорию build (при необходимости создать) и выполнить следующие команды:
+Перед началом работы необходимо убедиться в том, что у вас установлен `Qt6`, иначе будет собрана тестовая версия без UI. 
+
+Способы установки приводить не будем, так как это может сильно зависеть от вашей системы (по этой же причине отсутствует исполняемый файл). Искренне надеемся, что наш пользователь сможет разобраться с установкой.
+
+
+Далее необходимо выполнить следующие действия:
+1. Создать директорию для сбоки в корне проекта и перейти в нее
 
-1. Создать Makefile
 ```bash
-cmake ..
+mkdir build
+cmake -B build
+cd build
 ```
 
-2. Собрать исполняемый файл
+2. Создать Makefile
+```bash
+cmake
+```
+
+3. Собрать исполняемый файл
 ```bash
 make
 ```
 
-3. Запустить программу
+4. Запустить программу
 ```bash
 ./app
 ```
 
 Или же просто
 ```bash
-cmake .. && make && ./app
+cmake && make && ./app
 ```
 
 ### Запуск тестов
@@ -40,7 +126,7 @@ ctest -R "NaturalTests.CreateDefault"
 
 Или вместе со сборкой
 ```bash
-cmake .. && make && ctest -R "NaturalTests.CreateDefault"
+cmake && make && ctest -R "NaturalTests.CreateDefault"
 ```
 
 Возможный вывод:
@@ -56,9 +142,7 @@ Test project /colloquium_dmiti/build
 Total Test time (real) =   0.01 sec
 ```
 
-### Запуск тестов 2
-
-Чтобы вывести логи тестов введите эту команду
+Вывод логов проваленных тестов:
 ```bash
 ctest --rerun-failed --output-on-failure
 ```