Skip to content

docs: fix the docs that drifted from the code, add an architecture map and Vietnamese translations #21

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
longvo92 merged 1 commit into from
Jul 29, 2026
Merged

docs: fix the docs that drifted from the code, add an architecture map and Vietnamese translations #21

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@
[![License: MIT](https://img.shields.io/badge/license-MIT-green.svg)](LICENSE)
[![Release](https://img.shields.io/badge/release-v1.2.0-blue.svg)](https://github.com/longvo92/codegen-compare-tool/releases/latest)

🇻🇳 **Tiếng Việt:** [README](docs/vi/README.md) · [Kiến trúc](docs/vi/architecture.md)

Diff two AUTOSAR code-generation output folders (MATLAB/Simulink Embedded Coder) and show **only the changes that matter**.

Regenerating a Simulink model rewrites timestamps, UUIDs, comment banners and auto-generated variable names even when the behaviour is identical. This tool classifies every hunk as *real* or *ignorable*, then gives you two ways to review the result: a self-contained **HTML report** with an AUTOSAR-level summary on top of the text diff, and a **side-by-side desktop viewer** with a change minimap.
Expand Down
2 changes: 2 additions & 0 deletions docs/architecture.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Architecture

🇻🇳 Bản tiếng Việt: [vi/architecture.md](vi/architecture.md)

How the compare tool is put together, and why. For what it *does* — flags,
noise rules, screenshots — read the [README](../README.md) first; this document
is for someone about to change the code.
Expand Down
Loading
Loading