Merge pull request #81 from Debianov/docs

Docs
Debianov · Jul 10, 2024 · ebb1f1b · ebb1f1b
2 parents 07313ea + 8748e4e
commit ebb1f1b
Show file tree

Hide file tree

Showing 4 changed files with 14 additions and 38 deletions.
diff --git a/docs/diagram.png b/docs/diagram.png
diff --git a/pyproject.toml b/pyproject.toml
@@ -2,7 +2,7 @@
 name = "vtc-bot"
 version = "2.0.0"
 description = "The bot for managing a VTC."
-authors = ["GREEN Corporation <[email protected]>"]
+authors = ["vtc-bot contributors"]
 license = "GPL-2.0"
 readme = "readme.md"
 packages = [{include = "bot"}]

diff --git a/readme.md b/readme.md
@@ -3,13 +3,10 @@
 [Русская версия](./ru-readme.md)
 
 # Functional
-
 ![functional](./docs/diagram.png)
 
 # Install
-
 ## Database
-
 Run `./scripts/setupdb.sh` for creating tables from `schema.sql`:
 ```sh
 ./setupdb.sh <db_name> <db_user> 
@@ -44,15 +41,4 @@ At starts with other ways it causes the import errors.
 
 # Contributing
 The project stack: discord.py, psycopg, pytest + dpytest. Check out our 
-[contributing guidelines](./contributing.md) for ways to give feedback and contribute.
-
-## Dev dependencies
-```sh
-poetry install --with dev,docs
-```
-## Docs generation
-If you want a web version of the docs:
-```sh
-cd docs
-make html
-```
+[contributing guidelines](./contributing.md) for ways to give feedback and contribute.
diff --git a/ru-readme.md b/ru-readme.md
@@ -23,32 +23,22 @@ poetry install --only main
 ```
 
 # Запуск
-Не забываем установить зависимости:
+Создайте секретный файл с ключом, именем базы данных и именем.
 ```sh
-poetry install --only main
+DISCORD_API_TOKEN=...
+POSTGRES_DBNAME=...
+POSTGRES_USER=...
 ```
-Запуск осуществляется исключительно через poetry:
-```sh
-poetry run bot
-```
-Поскольку в проекте используется относительное
-импортирование, при запуске другим способом это приведёт к ошибкам импортирования.
-
-# Совместная разработка
-
-## Установка зависимостей
+После:
 ```sh
-poetry install --with dev,docs
+export file
 ```
-## Документация
-За внутреннюю документацию отвечает sphinx. Для его генерации необходимо:
+Затем:
 ```sh
-cd docs
-make html
+poetry run bot
 ```
+Запуск не через `poetry run` приведёт к ошибкам импортирования.
 
-Внешняя документация — документация всех функций, которые непосредственно вызываются при вызове команды — реализуется через команды типа "help".
-
-# Ресурсы проекта
-[Группа в VK](https://vk.com/vcsys)\
-[Цикл стримов с разработкой бота на YT](https://youtube.com/playlist?list=PLhz29l3FXDWhePFfKJw447uN3rLl020xz)
+# Совместная разработка
+Текущий стек проекта: discord.py, psycopg, pytest + dpytest. 
+Подробнее о правилах разработки: [contributing guidelines](./contributing.md).