From d0053df261420aa57d5952190a0326feb55b24b6 Mon Sep 17 00:00:00 2001 From: Maxim Slipenko Date: Sat, 3 Feb 2024 14:49:25 +0300 Subject: [PATCH] =?UTF-8?q?docs:=20=D0=BE=D0=B1=D0=BD=D0=BE=D0=B2=D0=BB?= =?UTF-8?q?=D1=91=D0=BD=20README.md=20(#106)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: MisterMLiL --- README.md | 8 +++++--- docs/grip.css | 17 +++++++++++++++++ 2 files changed, 22 insertions(+), 3 deletions(-) create mode 100644 docs/grip.css diff --git a/README.md b/README.md index fb6f722..c4ae7e5 100644 --- a/README.md +++ b/README.md @@ -20,9 +20,9 @@ ## Установка -Программа распространяется с помощью [PyInstaller](https://pyinstaller.org/en/stable/). +Программа распространяется с помощью [PyInstaller](https://pyinstaller.org/en/stable/). -Существует две версиии: **statapp** и **statapp-onefile**. +Существует две версиии: **statapp** и **statapp-onefile**. Различия в том, что onefile версия поставляется одним единственным бинарным файлом. На Windows системах с включенным антивирусом это может вызывать [некоторые проблемы](https://qna.habr.com/q/988553). @@ -39,9 +39,11 @@ poetry install pyinstaller statapp.spec # или pyinstaller statapp.spec -- --one-file ``` +Документация собирается с помощью [grip](https://github.com/joeyespo/grip) + ## Использование - +Использование описано в [Руководстве пользователя](docs/README.md). ## Чем я могу помочь проекту? diff --git a/docs/grip.css b/docs/grip.css new file mode 100644 index 0000000..37c03f2 --- /dev/null +++ b/docs/grip.css @@ -0,0 +1,17 @@ +#preview-page { + margin-top: 0px; + margin-bottom: 0px; +} + +#readme { + border: none; +} + +#readme > .Box-header { + border: none; + display: none !important; +} + +#readme > .Box-body { + border: none; +}