Skip to content

Add a badge page and ask for a star or a badge link - #579

Merged
ChrisonSimtian merged 3 commits into
Fallout-build:mainfrom
ChrisonSimtian:docs/fallout-badge
Jul 29, 2026
Merged

Add a badge page and ask for a star or a badge link#579
ChrisonSimtian merged 3 commits into
Fallout-build:mainfrom
ChrisonSimtian:docs/fallout-badge

Conversation

@ChrisonSimtian

Copy link
Copy Markdown
Collaborator

Adds docs/badge.md and asks readers for a star or a badge link.

The badge existed already but was text-only, because shields.io has no Fallout
icon. It now carries the radiation trefoil, embedded in the URL as a base64
data URI, so nobody has to host an image.

built with Fallout

What changed

  • New docs/badge.md: copy-paste markdown and HTML, six style and wording
    variants, the trefoil SVG source, and how to rebuild the URL by hand.
  • README gains a Contribute section between Activity and Sponsorship,
    plus a table-of-contents entry. It asks for a star or a badge link.
  • CONTRIBUTING.md gets one more bullet under baseline contributions.

Docs only. No code, no public API, no build changes.

Why

Two constraints are worth recording, because both are easy to get wrong later:

  • shields.io only recolours its own named icons. logoColor is ignored for a
    custom data URI, so the fill colour has to be written into the SVG. That is
    why the yellow and white trefoils are two separate SVGs.
  • The encoded logo is about 490 characters, putting the whole URL near 640.
    That fits GitHub's image proxy. A much larger SVG would not.

The short ?logo=fallout form needs the icon accepted into
simple-icons, which only takes
brands above a popularity bar. Fallout does not qualify yet, so that is filed
separately as #578 and the data URI stays the documented approach until then.

Verification

  • All seven badge URLs in the new docs return HTTP 200 from img.shields.io,
    with the logo present in the returned SVG.
  • Rendered every variant at true size on a white and a #0d1117 ground, and
    at 3x, to confirm the trefoil stays readable in the 14x14px logo slot.
  • Code fences balanced, the #copy-this anchor resolves, and every relative
    link in the three touched files points at a file that exists.

Part of #578

ChrisonSimtian and others added 2 commits July 27, 2026 20:37
shields.io has no Fallout icon, so the radiation trefoil rides in the badge
URL as a base64 data URI. Consumers need nothing hosted on their side.

Documents the copy-paste markdown and HTML, six style and wording variants,
the trefoil SVG source, and the two constraints that matter when modifying
it: logoColor does not apply to custom data URIs, and the encoded logo has
to stay small enough for GitHub's image proxy.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Adds a Contribute section to the README, between Activity and Sponsorship,
with the badge shown live and its markdown ready to copy. Extends the
baseline-contributions list in CONTRIBUTING with the same pointer.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
@ChrisonSimtian ChrisonSimtian added documentation Improvements or additions to documentation target/vCurrent Targets the current version labels Jul 27, 2026
@ChrisonSimtian
ChrisonSimtian marked this pull request as ready for review July 27, 2026 21:49
@ChrisonSimtian

Copy link
Copy Markdown
Collaborator Author

@dennisdoomen how do you feel about this badge as a small marketing thing?
the MD is horrible because we dont have enough stars to get a slur-style logo but I find it visually appealing :-) And its not a big fat ad banner but a small one in a dozen badges people can use in their readme.md ;-)

@ITaluone ITaluone left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Really nice!

Looking forward at a dedicated named icon

@ChrisonSimtian

Copy link
Copy Markdown
Collaborator Author

Really nice!

Looking forward at a dedicated named icon

me too but 10k stars seems a bit far away at the moment :-)

@dennisdoomen

Copy link
Copy Markdown
Collaborator

Love it ❤️

The Contribute section asks readers to display the badge; the badge row at
the top of the README now carries it too, since Fallout's build is itself a
Fallout build.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
@ChrisonSimtian
ChrisonSimtian merged commit 16b9c0c into Fallout-build:main Jul 29, 2026
1 check passed
@ChrisonSimtian
ChrisonSimtian deleted the docs/fallout-badge branch July 29, 2026 01:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation target/vCurrent Targets the current version

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants