diff --git a/readme.md b/readme.md index 6b0eaa3..b5b5eea 100644 --- a/readme.md +++ b/readme.md @@ -1,6 +1,43 @@ # Network Diagrams Tool -## UML Topology +Средство предназначено для описания конфигурации сети виртуальных машин в структурированном виде. Оно позволяет задавать устройства, интерфейсы и сети, а затем использовать это описание для получения формализованного представления конфигурации и построения диаграммы топологии. + +## Требования + +Для работы требуется: + +- Python 3; +- модуль `venv`; +- `pip`; +- зависимости из файла `requirements.txt`. + +Для генерации диаграмм через Graphviz также должен быть доступен Graphviz в системной среде. + +## Запуск + +В корневом каталоге проекта создайте и активируйте виртуальное окружение: + +```bash +python -m venv .venv +source .venv/bin/activate +``` + +Для Windows: + +```bat +python -m venv .venv +.venv\Scripts\activate +``` + +Установите зависимости и сам пакет в режиме разработки: + +```bash +pip install -r requirements.txt +pip install -e . +``` + +После этого средство можно запускать из установленного пакета или через Python-модули проекта. + +## UML-модель ![](UML/UML.svg?raw=true) -