Update project docs lang to Eng

Add FAQ.md and docs/
2026-10-21 12:28:30 +00:00 · 2026-02-18 19:53:39 +08:00
parent ae49ebe44a
commit d1e23a3179
5 changed files with 440 additions and 51 deletions
--- a/docs/CONTRIBUTING_ru.md
+++ b/docs/CONTRIBUTING_ru.md
@@ -0,0 +1,57 @@
+# Вклад в проект
+
+Спасибо за интерес к проекту.
+
+## Требования
+
+- Использовать Rust stable.
+- Перед PR код должен проходить форматирование, линт и сборку.
+
+## Быстрый старт
+
+```bash
+git clone https://github.com/dexoron/dcr.git
+cd dcr
+cargo check
+```
+
+## Стиль кода
+
+- Форматируйте код через `cargo fmt`.
+- Проверяйте предупреждения через `cargo clippy`.
+- Держите функции небольшими и сфокусированными.
+- Предпочитайте понятные имена вместо "хитрых".
+
+## Проверки
+
+Перед PR запускайте:
+
+```bash
+cargo fmt --all
+cargo clippy --all-targets --all-features -- -D warnings
+cargo check
+```
+
+## CI/CD и релизы
+
+- CI: `.github/workflows/ci.yml`
+- Release: `.github/workflows/release.yml`
+- Релиз запускается по тегу `v*` и публикует бинарники для:
+- `x86_64-unknown-linux-gnu`
+- `x86_64-apple-darwin`
+- `aarch64-apple-darwin`
+- `x86_64-pc-windows-msvc`
+
+## Коммиты и PR
+
+- Делайте коммиты понятными.
+- В PR указывайте краткое описание и мотивацию изменений.
+- Обновляйте документацию при изменении поведения.
+
+## Вопросы
+
+Если что-то непонятно, открой issue или задайте вопрос в PR.
+
+Также можно задать вопрос напрямую:
+- TG: @dexoron
+- DS: dexoron
--- a/docs/FAQ_ru.md
+++ b/docs/FAQ_ru.md
@@ -0,0 +1,102 @@
+# FAQ
+
+## В чем суть проекта?
+`dcr` - это инструмент для управления C/C++ проектами и их зависимостями.
+Он вдохновлен Cargo, но не является аналогом Makefile, CMake или других классических систем сборки.
+
+Цель проекта - дать более простую и удобную в настройке среду для разработки.
+
+## Как разрабатывается проект?
+Проект написан на Rust и в основном развивается одним разработчиком - Dexoron.
+
+В работе используются ИИ-инструменты, но они не пишут проект целиком: их роль - помощь с отдельными задачами (например, советы, проверка формулировок, переводы и т.д.).
+
+## Какие инструменты используются для разработки?
+Основной стек разработки:
+- `RustRover` 2025 - IDE для разработки.
+- `Codex` (`GPT-5.3-Codex (medium)`) - основной ИИ-инструмент, интегрированный через JetBrains AI Chat.
+- `Rust` - основной язык проекта.
+- `Cargo` - инструмент сборки, тестов и управления зависимостями Rust-проектов.
+
+## Проект открытый?
+Да, проект открыт (Open Source).
+Вы можете предлагать идеи, находить ошибки и вносить изменения в код.
+
+Проект распространяется по лицензии MIT (см. `LICENSE`).
+
+## Как внести вклад?
+Спасибо за желание помочь проекту.
+Вы можете:
+- помочь с кодом;
+- помочь с переводом;
+- помочь с документацией;
+- предложить идею или сообщить о баге.
+
+### Если вы хотите внести изменения (код, перевод, документация)
+1. Сделайте форк нужного репозитория: `dexoron/dcr` (основной проект) или `dexoron/dcr-site` (сайт проекта).
+2. Внесите изменения с учетом правил из `CONTRIBUTING.md`.
+3. Отправьте изменения в свой форк.
+4. Создайте Pull Request.
+5. Дождитесь ревью.
+
+### Если вы хотите сообщить о проблеме или предложить идею
+1. Откройте нужный репозиторий: `dexoron/dcr` или `dexoron/dcr-site`.
+2. Перейдите во вкладку `Issues`.
+3. Создайте Issue и укажите тип (баг, предложение, вопрос/помощь).
+4. Опишите проблему или идею кратко и понятно.
+5. Дождитесь обратной связи.
+
+## Как установить `dcr`?
+Актуальные способы установки зависят от текущей версии проекта.
+Рекомендуемый путь:
+- проверьте инструкции в `README.md`;
+- если готового пакета для вашей платформы нет, соберите проект из исходников через `cargo build --release`.
+
+## Как быстро начать работу?
+Минимальный сценарий:
+1. Установите `dcr`.
+2. Создайте проект (или перейдите в существующий C/C++ проект).
+3. Инициализируйте конфигурацию `dcr`.
+4. Добавьте зависимости проекта.
+5. Запустите сборку через `dcr`.
+
+Подробные команды и примеры смотрите в `README.md` и документации проекта.
+
+## На какой стадии проект?
+`dcr` активно развивается.
+Это означает, что интерфейсы и поведение некоторых функций могут меняться между версиями.
+
+Перед обновлением рекомендуется читать changelog и проверять заметки к релизу.
+
+## С какими системами работает `dcr`?
+`dcr` ориентирован на современные среды разработки C/C++.
+Фактическая совместимость зависит от версии `dcr`, операционной системы и используемого toolchain.
+
+Перед началом работы проверьте в документации:
+- поддерживаемые ОС;
+- поддерживаемые компиляторы и линкеры;
+- ограничения конкретной версии.
+
+## Чем `dcr` отличается от Make/CMake?
+`dcr` не пытается быть прямой заменой Make/CMake.
+Главный фокус `dcr` - упростить управление проектом и зависимостями в стиле, близком к опыту Cargo.
+
+Если вам нужен низкоуровневый полный контроль над процессом сборки, классические инструменты могут быть привычнее.
+Если нужна более простая и единообразная модель конфигурации - `dcr` может быть удобнее.
+
+## Где смотреть документацию и примеры?
+Основные источники:
+- `README.md` в репозитории;
+- документация проекта (смотреть сайт проекта);
+- `Issues` для известных проблем и обсуждений;
+
+## Как правильно сообщить о баге?
+Чтобы баг-репорт можно было быстро воспроизвести, укажите:
+1. Версию `dcr`.
+2. ОС и версию компилятора/toolchain.
+3. Шаги воспроизведения.
+4. Ожидаемое поведение.
+5. Фактическое поведение и текст ошибки.
+6. Минимальный пример проекта (по возможности).
+
+Баги и проблемы отправляйте через `Issues` в соответствующем репозитории.
--- a/docs/README_ru.md
+++ b/docs/README_ru.md
@@ -0,0 +1,128 @@
+# DCR (Dexoron Cargo Realization)
+
+DCR — это утилита для управления проектами на C/C++ в стиле Cargo.
+
+Текущая реализация написана на Rust.
+
+## Зачем DCR
+- Единая структура проекта без ручной настройки
+- Простые команды для типовых задач
+- Прозрачная компиляция и предсказуемые профили сборки
+
+## Возможности
+- Создание нового проекта или инициализация текущей директории
+- Сборка проекта в профилях `debug` и `release`
+- Запуск собранного бинарника
+- Очистка результатов сборки
+- Генерация минимального шаблона C-проекта
+- Обновление бинарника через `dcr --update` (GitHub Releases)
+
+## Поддерживаемые платформы
+- Linux: `x86_64-unknown-linux-gnu`
+- macOS Intel: `x86_64-apple-darwin`
+- macOS Apple Silicon: `aarch64-apple-darwin`
+- Windows: `x86_64-pc-windows-msvc`
+
+## Установка
+
+### Из исходников
+
+```sh
+git clone https://github.com/dexoron/dcr.git
+cd dcr
+cargo build --release
+mkdir -p ~/.local/bin
+ln -sf "$PWD/target/release/dcr" ~/.local/bin/dcr
+```
+
+### Через install.sh (Linux/macOS)
+
+```sh
+curl -fsSL https://dcr.dexoron.su/install.sh | bash
+```
+
+### Через install.ps1 (Windows)
+
+```powershell
+irm https://dcr.dexoron.su/install.ps1 | iex
+```
+
+Оба скрипта при запуске спрашивают:
+- скачать готовый бинарник из GitHub Release
+- или собрать проект из `git`
+
+Релизные ассеты:
+- `dcr-x86_64-unknown-linux-gnu`
+- `dcr-x86_64-apple-darwin`
+- `dcr-aarch64-apple-darwin`
+- `dcr-x86_64-pc-windows-msvc.exe`
+
+## Быстрый старт
+
+Создать новый проект:
+`dcr new hello`
+
+Или инициализировать текущую директорию (директория должна быть пустой):
+`dcr init`
+
+Структура проекта:
+
+```txt
+hello/
+- src/
+- - main.c
+- dcr.toml
+```
+
+Сборка и запуск проекта:
+`dcr run` или `dcr run --release`
+
+## Команды
+
+### `dcr new <name>`
+Создает проект в текущей директории с указанным именем.
+
+### `dcr init`
+Создает проект в текущей директории. Имя проекта будет равно имени директории. Директория должна быть пустой.
+
+### `dcr build [profile]`
+Собирает проект. Если профиль не указан, используется `--debug`.
+
+### `dcr run [profile]`
+Собирает проект и запускает бинарник. Если профиль не указан, используется `--debug`.
+
+Запуск вручную:
+`./target/<profile>/main`
+
+### `dcr clean`
+Удаляет папку `target` в корне проекта.
+
+## Профили сборки
+Поддерживаются два профиля:
+- `--debug` (по умолчанию) — флаги: `-O0 -g -Wall -Wextra -fno-omit-frame-pointer -DDEBUG`
+- `--release` — флаги: `-O3 -DNDEBUG -march=native`
+
+## Конфигурация
+Основной файл проекта — `dcr.toml`.
+
+Пример `dcr.toml`:
+
+```toml
+[package]
+name = "hello"
+version = "0.1.0"
+language = "c"
+compiler = "clang"
+
+[dependencies]
+```
+
+## Требования
+- Rust toolchain (`rustc`, `cargo`) - Для ручной сборки DCR
+- C-компилятор (`clang`, `gcc` или другие)
+
+## Релизы
+Релизы собираются автоматически через GitHub Actions (`.github/workflows/release.yml`) при пуше тега формата `v*`.
+
+## Лицензия
+См. файл `LICENSE`.