Доброго часу доби всім. Оскільки не являюсь професійним програмістом, і займаюся програмування виключно як хобі, то не маю достатніх навичок в написанню документації. Хочу показати шматок української версії редмі файлу, щоб люди котрі розуміються краще від мене оцінили чи має право на існування таке шось.
▼readme
...
__________________________________________________________________________________________
#Налаштування сервера, змінні середовища.
Налаштування сервера можна зберегти двома способами в змінних середовища, aбо в файлі .env.
Для налаштування додатку нееобхідно задати наступні параметри:
FLASK_APP - ім'я файлу аплікації.
SECRET_KEY - це криптографічний ключ, котрий розширення Flask-WTF використовує для
захисту веб-форм від атаки Cross-Site Request Forgery (CSRF).
DATABASE_URL - шлях до баз данних. Якщо змінна не буде налаштована, то буде
використано шлях за замовчуванням `/app.db`.
MAIL_PORT - налаштування порту для електронної пошти за замовчуванням `25`.
MAIL_SERVER - поштовий сервер .
MAIL_USE_TLS - налаштувння протокола `TLS`.
MAIL_USERNAME - адреса поштової скриньки з котрої буде вестися розсилка.
MAIL_PASSWORD - пароль до поштової скриньки з котрої буде вестися розсилка.
FLASK_DEBUG - вмикає режим відладки додатку на тестовому сервері можна використовувати.
режим відладки для ввімкнення треба присвоїти цьому параметру значення `True` на продакшн
сервері рекомендоване значення `False`.
___________________________________________________________________________________________
##Для збереження в змінних середовища в лінукс
В терміалі:
`export <ім'я_параметра>=<значення>` (важливо перед і після знаку `=` не можна класти
знаку пробіл)
___________________________________________________________________________________________
##Для збереження в змінних середовища в віндовс
В командному рядку:
`set <ім'я_параметра>=<значення>` (важливо перед і після знаку `=` не можна класти
знаку пробіл)
___________________________________________________________________________________________
##Для збереження в файлі .env
За замовченням такого файлу немає в кореневій дерикторії, тому його треба створити
самостійно. Файл повинен виглядати наступним чином:
SECRET_KEY = "xxxxx"
FLASK_APP = "xxxxxx"
MAIL_SERVER = "xxxxxx"
MAIL_PORT = xx
MAIL_USE_TLS = x
MAIL_USERNAME = "xxxxxx"
MAIL_PASSWORD = "xxxxxx"
FLASK_DEBUG = "xxxxxx"
Після `=` повинні бути відповідні значення.
___________________________________________________________________________________________
##Захаркоджування параметрів
Крім того налаштування можна за харкодити в файлі config.py однак цей спосіб не є рекомендованим для використання єдиний виняток, якщо середовище не визначає зміниих середовища.
___________________________________________________________________________________________
#Список поштових скриньок адміністраторів
Поштов іскринькі адміністраторів, необхідні для відправки їм повідомлень про помилки і зберігається в файлі config.py в списку `ADMINS` і змінюється шляхом його редагування.
...
Також буду вдячний за поради.
Окрім того, хотів би запитати, якщо я хочу зробити документацію на кількох мовах, краще писати її в однім файлі чи зробити кілька файлів припустимо щось таке:
README.md
UAREADME.md
PLREADME.md
Дякую.
Частково поправив. Дякую javascriptlife.