From 484affa866732e476e7283411b120374c8a43ea2 Mon Sep 17 00:00:00 2001
From: Evgeny Kislov <dev@evgenykislov.com>
Date: Mon, 5 Aug 2024 02:15:09 +0300
Subject: [PATCH] Adds Russian description (readme).

---
 README_rus.md | 61 +++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 61 insertions(+)
 create mode 100644 README_rus.md

diff --git a/README_rus.md b/README_rus.md
new file mode 100644
index 0000000..b3c82a9
--- /dev/null
+++ b/README_rus.md
@@ -0,0 +1,61 @@
+# Ctrl+C
+
+Кроссплатформенный код (C++11) для обработки события Ctrl+C в пользовательских функциях.
+Поддерживаются Windows, Linux и Mac OS X.
+
+## Использование
+
+Для обработки события/сигнала Ctrl+C следует вызвать функцию:
+```cpp
+unsigned int CtrlCLibrary::SetCtrlCHandler(std::function<bool(enum CtrlCLibrary::CtrlSignal)> handler);
+```
+где handler - пользовательская функция;
+
+**Возвращаемое значение**:
+Возвращается идентификатор добавленного обработчика. В случае ошибки возвращается CtrlCLibrary::kErrorID.
+
+Для удаления обработчика следует вызвать функцию:
+```cpp
+void CtrlCLibrary::ResetCtrlCHandler(unsigned int id);
+```
+где id - идентификатор обработчика, возвращённый функцией CtrlCLibrary::SetCtrlCHandler.
+
+### Установка
+
+Скопируйте файлы с кодом (src/ctrl-c.h, src/ctrl-c.cpp) в свой проект.
+
+## Пример использования
+
+Файл test/main.cpp показывает использование обработчика Ctrl+C.
+Скомпилируйте  этот код своим любимыми компилятором.
+
+## Автор
+
+**Евгений Кислов** - [evgenykislov.com](https://evgenykislov.com), [github/evgenykislov](https://github.com/evgenykislov)
+
+## Лицензия
+
+Проект лицензирован под MIT License. Подробнее см. файл [LICENSE](LICENSE)
+
+## Примечания
+
+Допускается добавлять несколько обработчиков события Cntl+C. Все обработчики будут вызываны в обратном порядке (LIFO): первый добавленный обработчик будет вызван последним.
+Каждый обработчик должен вернуть значение bool:
+* *true* - остановить обработку и не вызывать последующие обработчики;
+* *false* - продолжить обработку сигнала другими (следующими в очереди) обработчиками (дополнительно, см. примечания для Windows ниже).
+
+Функции установки и сброса обработчика, а также сам обработчик являются потокобезопасными.  *Внимание*: Не следует удалять обработчик события в самом обработчике события - это может вызвать блокироку (deadlock).
+
+#### Ошибки
+Добавление нового обработчика может вернуть ошибку (kErrorID) в случае недостатка памяти или системной ошибки.
+
+#### Исключения
+Код обрабатывает свои ошибки, а также ошибки выделения памяти в вызове SetCtrlCHandler. В этом случае возвращается идентификатор (kErrorID).
+Другие исключения не обрабатываются, следует их ловить (и обрабатывать) в своём коде.
+
+#### Примечания для Linux и Mac OS X
+Установка любого обработчика приведёт к тому, что предыдущий обработчик перестанет работать. Если первое добавление обработчика возвратит ошибку, то предыдущий обработчик также перестанет работать - ОС будет вызывать обработчик по-умолчанию.
+Удаление всех обработчиков приведёт к установке обработчика Ctrl+C по-умолчанию.
+
+#### Примечания для Windows
+Если все обработчики вернут **false**, то будет вызван предыдущий обработчик. Это может быть обработчик самой ОС и в этом случае процесс может быть закрыт.