Initial commit

2026-09-06 01:06:40 +08:00
commit 57c4e80f0d
69 changed files with 20940 additions and 0 deletions
@@ -0,0 +1,40 @@
+# Правила проекта
+
+## Общие
+
+Перед каждым изменением любого файла читай его.
+
+После каждого изменения в коде обновляй документацию в README.md, AGENTS.md и директории docs/.
+
+## Документация
+
+Читай её перед началом работы.
+
+Обновляй её после изменений в проекте.
+
+README.md — обзор проекта: возможности, карта документов, быстрый старт, лицензия, предостережение.
+
+Тематические документы лежат в docs/:
+* INSTALL.md - установка
+* COLOR-MODES.md - режимы
+* cli/ - команды (обзор и карта файлов — в cli/README.md)
+* EXTENDING.md - расширение
+* PROTOCOL.md - протокол
+* SCRIPTS.md - скрипты
+* RAW-DATA.md - дампы
+
+Пользовательские вопросы — в тематических документах, реверс-инжиниринг — в PROTOCOL.md.
+
+Ссылки между документами — относительные, без якорей на заголовки с кириллицей.
+
+## Markdown
+
+Каждое предложение должно начинаться с новой строки.
+
+Обращайся к читателю на "вы", с маленькой буквы (кроме начала предложения).
+
+## Python
+
+Код должен быть читаем человеком, простым и хорошо прокомментированным на русском языке.
+
+Исполняемые скрипты должны быть с разрешённым `+x`.