Skip to content

docs: обновить раздел Linux-зависимостей в README#1671

Open
johnnyshut wants to merge 2 commits intoEvilBeaver:developfrom
johnnyshut:docs/1437
Open

docs: обновить раздел Linux-зависимостей в README#1671
johnnyshut wants to merge 2 commits intoEvilBeaver:developfrom
johnnyshut:docs/1437

Conversation

@johnnyshut
Copy link
Copy Markdown
Contributor

@johnnyshut johnnyshut commented Apr 30, 2026

Зачем

Закрыть #1437: актуализировать документацию по установке зависимостей для Linux без изменений в коде ядра.

Что изменили

  • Обновили Linux-разделы в README.md и README-EN.md.
  • Разделили инструкции для веток:
    • v2.x (на базе .NET 8): уточнили различие SCD/FDD и требование runtime для FDD.
    • v1.x LTS: уточнили зависимость от Mono для сценариев отладки.
  • Убрали избыточно подробные/хрупкие команды установки и оставили ссылки на официальные инструкции (Microsoft/Mono), чтобы снизить риск устаревания документации.

Что НЕ меняли

  • Код движка и стандартной библиотеки.
  • Поведение runtime/сборки.

Summary by CodeRabbit

  • Documentation
    • Expanded Linux install docs for v2.x to describe the two .NET 8.0 ZIP variants (SCD vs FDD) and note that FDD requires installing .NET Runtime 8.0.
    • Clarified v1.x LTS .deb (Mono) install guidance and debugger requirements.
    • Adjusted Linux usage examples (chmod/run) and added Ubuntu/Debian debugger troubleshooting guidance.

…md с добавлением информации о вариантах ZIP-архивов для .NET 8.0 и необходимых зависимостях
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Apr 30, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 52a4a401-8f9b-4812-97bc-14531fe6ba06

📥 Commits

Reviewing files that changed from the base of the PR and between 97f8bb7 and 8c22202.

📒 Files selected for processing (2)
  • README-EN.md
  • README.md
✅ Files skipped from review due to trivial changes (1)
  • README.md

📝 Walkthrough

Walkthrough

Documentation updates adding Linux installation instructions for v2.x (.NET 8.0: SCD vs FDD) and v1.x LTS (Mono .deb), clarifying runtime and debugging (mono-complete) requirements and adjusting chmod example.

Changes

Cohort / File(s) Summary
Linux README updates
README-EN.md, README.md
Added guidance for v2.x (.NET 8.0) ZIP variants distinguishing SCD (self-contained) and FDD (requires external .NET Runtime 8.0), adjusted chmod example to ./oscript, and added v1.x LTS .deb (Mono) notes including mono-complete for debugger breakpoints and link to Mono repo install instructions.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Suggested reviewers

  • EvilBeaver

Poem

🐰 I nibble docs beneath the moonlit glow,
SCD and FDD now in a tidy row,
v2 and v1, each told with care,
chmod hops lightly — ./oscript there!
Debugger carrots saved in mono-complete fare. 🥕

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'docs: обновить раздел Linux-зависимостей в README' (docs: update Linux-dependencies section in README) accurately describes the main change—updating Linux installation documentation for dependencies across both README files.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
Review rate limit: 7/8 reviews remaining, refill in 7 minutes and 30 seconds.

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 4

🧹 Nitpick comments (1)
README-EN.md (1)

50-52: ⚡ Quick win

Minor doc clarity: make the chmod command explicitly relative.

For the extracted ZIP, consider updating (Line 51) to chmod +x ./oscript so it’s unambiguous that it targets the binary in the current directory.

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@README-EN.md` around lines 50 - 52, Update the README-EN.md instruction that
currently shows the chmod example to explicitly reference the local binary by
changing the existing `chmod +x oscript` line to `chmod +x ./oscript`; locate
the code block containing the `oscript` chmod example and replace the command so
it unambiguously targets the binary in the current directory.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@README-EN.md`:
- Line 56: The ATX heading "#### v1.x LTS — deb package (Mono)" violates MD003;
update this heading to use the closed ATX style by adding trailing hashes so it
becomes "#### v1.x LTS — deb package (Mono) ####" (i.e., modify the heading
string in the README to include closing '#' characters for the same level).
- Line 37: The heading "#### v2.x (current branch) — .NET 8.0 based" should use
closed ATX style to match the repo and silence MD003; update that heading to
include trailing hashes (e.g., "#### v2.x (current branch) — .NET 8.0 based
####") so it is consistent with other headings like "### Windows ###".

In `@README.md`:
- Line 56: Update the Russian heading "#### v1.x LTS — deb-пакет (Mono)" to
closed ATX style by appending trailing hashes so it becomes "#### v1.x LTS —
deb-пакет (Mono) ####", ensuring consistency with other headings and satisfying
markdownlint MD003; modify the heading text exactly where "v1.x LTS — deb-пакет
(Mono)" appears.
- Line 37: The heading "#### v2.x (текущая ветка) — на базе .NET 8.0" is using
an open ATX style while other headings use closed ATX; update that heading (the
string "v2.x (текущая ветка) — на базе .NET 8.0") to a closed style by appending
trailing hashes (e.g., "#### v2.x (текущая ветка) — на базе .NET 8.0 ####") so
it matches the rest of the README's heading style.

---

Nitpick comments:
In `@README-EN.md`:
- Around line 50-52: Update the README-EN.md instruction that currently shows
the chmod example to explicitly reference the local binary by changing the
existing `chmod +x oscript` line to `chmod +x ./oscript`; locate the code block
containing the `oscript` chmod example and replace the command so it
unambiguously targets the binary in the current directory.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 3a7c8a34-cf85-414f-9463-d28dd4937318

📥 Commits

Reviewing files that changed from the base of the PR and between c455964 and 97f8bb7.

📒 Files selected for processing (2)
  • README-EN.md
  • README.md

Comment thread README-EN.md Outdated
Comment thread README-EN.md Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
… .NET 8.0 и LTS версии, добавление символов завершения
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant