Skip to content

Commit bfbd8a0

Browse files
committed
Update README.md
1 parent 95ddc57 commit bfbd8a0

File tree

1 file changed

+48
-7
lines changed

1 file changed

+48
-7
lines changed

README.md

Lines changed: 48 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,6 @@
1717
- Загрузка и скачивание файлов, OTA обновление (ESP8266/ESP32)
1818
- Работает на базе Arduino Client, возможна работа по Ethernet, GSM и так далее
1919

20-
> Библиотека в разработке! Руководствуйтесь примером и подсказками IDE
21-
2220
### Совместимость
2321
Любые Arduino
2422

@@ -27,13 +25,56 @@
2725
- [StringUtils](https://github.com/GyverLibs/StringUtils) v1.4.14+
2826
- [GyverHTTP](https://github.com/GyverLibs/GyverHTTP) v1.0.2+
2927

30-
## Установка
31-
Библиотека не в релизе, качайте репозиторий zip архивом (кнопка Code справа вверху) или по [прямой ссылке](https://github.com/GyverLibs/FastBot2/archive/refs/heads/main.zip) на загрузку.
28+
## Содержание
29+
- [Документация](#docs)
30+
- [Версии](#versions)
31+
- [Установка](#install)
32+
- [Баги и обратная связь](#feedback)
33+
34+
<a id="docs"></a>
35+
36+
## Документация
37+
Находится в [папке docs](https://github.com/GyverLibs/FastBot2/tree/main/docs/1.main.md)
3238

33-
## Вывод графики
39+
### Вывод графики
3440
Используйте библиотеку [CharDisplay](https://github.com/GyverLibs/CharDisplay) для вывода графиков и рисования в чате!
3541

3642
![](https://github.com/GyverLibs/CharDisplay/blob/main/docs/plots.png)
3743

38-
## Документация
39-
Находится в [папке docs](https://github.com/GyverLibs/FastBot2/tree/main/docs/1.main.md)
44+
<a id="versions"></a>
45+
46+
## Версии
47+
- v1.0
48+
49+
<a id="install"></a>
50+
51+
## Установка
52+
- Библиотеку можно найти по названию **FastBot2** и установить через менеджер библиотек в:
53+
- Arduino IDE
54+
- Arduino IDE v2
55+
- PlatformIO
56+
- [Скачать библиотеку](https://github.com/GyverLibs/FastBot2/archive/refs/heads/main.zip) .zip архивом для ручной установки:
57+
- Распаковать и положить в *C:\Program Files (x86)\Arduino\libraries* (Windows x64)
58+
- Распаковать и положить в *C:\Program Files\Arduino\libraries* (Windows x32)
59+
- Распаковать и положить в *Документы/Arduino/libraries/*
60+
- (Arduino IDE) автоматическая установка из .zip: *Скетч/Подключить библиотеку/Добавить .ZIP библиотеку…* и указать скачанный архив
61+
- Читай более подробную инструкцию по установке библиотек [здесь](https://alexgyver.ru/arduino-first/#%D0%A3%D1%81%D1%82%D0%B0%D0%BD%D0%BE%D0%B2%D0%BA%D0%B0_%D0%B1%D0%B8%D0%B1%D0%BB%D0%B8%D0%BE%D1%82%D0%B5%D0%BA)
62+
### Обновление
63+
- Рекомендую всегда обновлять библиотеку: в новых версиях исправляются ошибки и баги, а также проводится оптимизация и добавляются новые фичи
64+
- Через менеджер библиотек IDE: найти библиотеку как при установке и нажать "Обновить"
65+
- Вручную: **удалить папку со старой версией**, а затем положить на её место новую. "Замену" делать нельзя: иногда в новых версиях удаляются файлы, которые останутся при замене и могут привести к ошибкам!
66+
67+
<a id="feedback"></a>
68+
69+
## Баги и обратная связь
70+
При нахождении багов создавайте **Issue**, а лучше сразу пишите на почту [[email protected]](mailto:[email protected])
71+
Библиотека открыта для доработки и ваших **Pull Request**'ов!
72+
73+
При сообщении о багах или некорректной работе библиотеки нужно обязательно указывать:
74+
- Версия библиотеки
75+
- Какой используется МК
76+
- Версия SDK (для ESP)
77+
- Версия Arduino IDE
78+
- Корректно ли работают ли встроенные примеры, в которых используются функции и конструкции, приводящие к багу в вашем коде
79+
- Какой код загружался, какая работа от него ожидалась и как он работает в реальности
80+
- В идеале приложить минимальный код, в котором наблюдается баг. Не полотно из тысячи строк, а минимальный код

0 commit comments

Comments
 (0)