Skip to content

Trim README, replace stale CDP4 package icon with Auriga branding - #150

Open
samatstariongroup wants to merge 4 commits into
developmentfrom
readme-and-icon-branding
Open

Trim README, replace stale CDP4 package icon with Auriga branding#150
samatstariongroup wants to merge 4 commits into
developmentfrom
readme-and-icon-branding

Conversation

@samatstariongroup

@samatstariongroup samatstariongroup commented Aug 7, 2026

Copy link
Copy Markdown
Member

Summary

  • Trims README.md to a concise overview (package sections cut to 1-3 sentences, Getting Started examples consolidated), pointing deep-dives at the wiki.
  • Adds the Auriga brand assets (assets/) and adds the README emblem, sourced from an absolute raw.githubusercontent.com link so it also renders on the NuGet package page.
  • Replaces the stale cdp4-icon.png (a leftover from another Starion project) with auriga-icon-512.png as the shared PackageIcon for all five packable projects.
  • Sets auriga.ico as Auriga.Tools's ApplicationIcon, so the published aurigatools.exe carries the real Auriga icon instead of the default .NET one. Verified the icon embeds and extracts from the built exe.
  • Keeps Auriga.Samples/ReadmeSamples.cs in sync with the README's consolidated reporting sample: the three separate sample methods (RenderDiagramsToSvg, RasterizeDiagramsToPng, ExportTablesToExcel) are merged into one RenderAndExportDiagrams, matching the merged code block the README trim introduced. This was required — CI's ReadmeSampleTestFixture asserts the README's fenced C# samples are compiled verbatim by Auriga.Samples, and failed once the README changed without the samples project following.

Test plan

  • dotnet build Auriga.sln -c Debug — succeeds, no new warnings.
  • dotnet pack Auriga.Tools.csproj -c Debug — packs cleanly with the new icon and README.
  • Extracted the icon from the built Auriga.Tools.exe to confirm it embedded correctly.
  • dotnet test Auriga.Tests --filter ReadmeSampleTestFixture — passes after syncing Auriga.Samples with the trimmed README (this is the check that caught the drift in CI).

@github-actions

github-actions Bot commented Aug 7, 2026

Copy link
Copy Markdown
Contributor
Package Line Rate Branch Rate Complexity Health
Auriga 35% 49% 21825
Auriga.CodeGenerator 90% 79% 650
Auriga.Extensions 35% 32% 1979
Auriga.Reporting 97% 92% 1398
Auriga.Tools 89% 89% 129
Auriga.Xmi 26% 14% 68397
Summary 30% (51344 / 173282) 22% (17623 / 80594) 94378

@sonarqubecloud

sonarqubecloud Bot commented Aug 7, 2026

Copy link
Copy Markdown

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