From bf9a0accb77f1b03167de768a7ce2ef01d1e4047 Mon Sep 17 00:00:00 2001
From: pvoid <agplastictown@yandex.ru>
Date: Thu, 11 Dec 2025 20:08:00 +0000
Subject: [PATCH] =?UTF-8?q?=D0=9E=D0=B1=D0=BD=D0=BE=D0=B2=D0=B8=D1=82?=
 =?UTF-8?q?=D1=8C=20README.md?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 README.md | 42 +++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 41 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 620b7ad..cd56070 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,43 @@
 # astyle-port
 
-Порт artistic style для Колибри ОС
\ No newline at end of file
+### Порт artistic style для Колибри ОС
+
+См. https://astyle.sourceforge.net/
+
+* Умеет форматировать код с-подобных языков программирования в разных стилях
+* Запускается из консоли
+* Исполняемый файл `astyle` находится в корне репозитория
+* Полный набор флагов в официальной документации
+
+### Пример использования:
+
+`astyle source_dir/* --style=gnu -s2`
+
+Форматирует файлы в директории source_dir в стиле gnu с отступами в 2 пробела
+
+### Особенности
+* Не сохраняет время изменения файла из-за отсутствия функции utime() в libc
+* Использует самодельную `std:filesystem` на основе `boost::filesystem` с минимальной функциональностью,
+возможны баги
+
+=========================================================
+
+### Artistic Style port for Kolibri OS
+
+See https://astyle.sourceforge.net/
+
+* Formats the code of c-like programming languages in different styles
+* Executed from the console
+* The `astyle` executable file is located in the root of the repository
+* The full set of flags and features in the official documentation
+
+### How to use:
+
+`astyle source_dir/* --style=gnu -s2`
+
+Formats files in the source_dir directory in the gnu style with 2 spaces indentation.
+
+### Miscellaneous
+* It does not save the file modification time due to the lack of the utime() function in libc.
+* Uses a self-made `std:filesystem` based on `boost::filesystem` with minimal functionality,
+bugs are possible
\ No newline at end of file