documentation WIP

setup.md

@@ -0,0 +1,25 @@
+# Краткий гайд по установке и настройке бота.
+Бот устанавливается с помощью **docker compose** файла и **git pull** (предварительно) и последующей лёгкой настройки через файлы.
+Данный "гайд" расчитан на **linux** и **docker**, однако вы можете развернуть данное приложение/бота на любой системе с *Python 3*.
+### Для установки через `docker compose`:
+1) Создайте директорию для бота
+2) Введите команду:
+```
+git clone
+```
+### После базовой развёртки выполните следующие шаги:
+1) Создайте data.json файл и заполните его данным содержимым:
+```> {}```
+2) Создайте файл `credentials.py` в `src/` и заполните его по аналогии с `cretentialsExample.py` 
+*Рекомендуется использовать суб аккаунт Bybit для бота*
+3) Настройте options.py файл на ваше усмотрение (обратите особо внимание на параметр `testnet`)
+4) Погадайте на молочной гуще и сделайте ***4*** круга с пчелиным ульем вокруг сервера
+5) Всё готово к запуску, наслаждайтесь!
+### Для запуска бота введите следующую команду:
+```
+docker compose up -d
+```
+*По надобности используйте `sudo` перед командой*
+6) На платформе **Bybit** включите режим хеджирования на все пары, которыми планируете торговать
+
+Спасибо что заглянули, желаем удачной настройки и стабильной работы!