Add readme

This commit is contained in:
Viktoria Polyakova
2025-03-29 18:03:11 +03:00
parent 409c60610a
commit f99ba003cf
4 changed files with 53 additions and 2 deletions

51
README.md Normal file
View File

@@ -0,0 +1,51 @@
# Генератор подписи для почтовых сообщений в формате HTML
Данное программное обеспечение предназначено для формирования подписи для почтовых сообщений в формате HTML и вставки в тело почтового сообщения.
## Интерфейс
![Главный экран](docs/main_form.png)
## Шаблон
Для изменения выводимой подписи, неоходимо отредактировать файл template.html
![Шаблон](docs/template.png)
### Описание параметров
* {username} - Имя и фамилия
* {jobtitle} - Должность
* {mgts} - Рабочий телефон и добавочный нормер, если указан
* {mobile} - Мобильный телефон
* {logo} - Изображение, сконвертированное в формат Base64 для вставки в атрибут SRC тега IMG
## Компиляция исходного кода
Для компиляции установите зависимости библиотек
```bash
pip install -r ./requirements.txt
```
Запустите компиляцию
```bash
./build.sh
```
или
```bash
python -m PyInstaller --onefile -n "SignGenerator" --windowed --icon=ui/sign.ico main.py
```
или
```bash
pyinstaller --onefile -n "SignGenerator" --windowed --icon=ui/sign.ico main.py
```
Скомпилированный файл появится в каталоге dist
**Для корректного запуска, необходиимо скопировать каталог ui в каталог dist.**

View File

@@ -1,6 +1,6 @@
[General]
firstname = Сергей
lastname = Гусенков
firstname = Иван
lastname = Иванов
jobtitle = Руководитель отдела продаж
gtsphone = +7 (499) 229-60-00
gtsphoneadd = 303

BIN
docs/main_form.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 111 KiB

BIN
docs/template.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 62 KiB