Skip to content

Commit 9eade68

Browse files
committed
docs: SF Symbol on Liquid Glass as illustrative hero, clip-art clock as original-art example
1 parent 818ec6f commit 9eade68

4 files changed

Lines changed: 17 additions & 7 deletions

File tree

README.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,9 @@
99
[![Toolchain](https://img.shields.io/badge/Xcode-26%2B-black.svg)](https://developer.apple.com/xcode/)
1010
[![PRs welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](CONTRIBUTING.md)
1111

12-
<img src="docs/assets/preview-strip.png" alt="light / dark / tinted / clear previews of a demo icon" width="760">
12+
<img src="docs/assets/preview-strip.png" alt="light / dark / tinted / clear previews of an SF Symbol on Liquid Glass" width="760">
13+
14+
<sub><em>Illustrative: an SF Symbol (`clock.fill`) on Liquid Glass, previewed across appearances. SF Symbols are great for prototyping — but <a href="docs/sf-symbols.md">don't ship one as a real app icon</a>.</em></sub>
1315

1416
</div>
1517

@@ -67,6 +69,11 @@ bin/glassmith integrate --project App.xcodeproj --target App --icon AppIcon.icon
6769
A small, ergonomic JSON that maps onto `icon.json`. You provide flat layers; you
6870
do **not** bake in highlights or shadows — the OS does that.
6971

72+
<div align="center">
73+
<img src="docs/assets/clock-strip.png" alt="original clip-art clock across appearances" width="680">
74+
<br><sub><em>Original artwork (no Apple assets): the bundled <code>examples/demo</code> clip-art clock.</em></sub>
75+
</div>
76+
7077
```json
7178
{
7279
"name": "AppIcon",

docs/assets/clock-strip.png

71.2 KB
Loading

docs/assets/preview-strip.png

-46.7 KB
Loading

docs/sf-symbols.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -25,15 +25,18 @@ So treat this source as **prototyping only**:
2525

2626
- ✅ Mock up layout, background, colour and the glass treatment fast.
2727
- ✅ Explore depth/specular before commissioning real art.
28-
- ❌ Do not commit Apple's rendered symbol pixels to a repo you publish.
28+
- ✅ Show a rendered symbol in docs/marketing to *illustrate the tool* (the
29+
README hero does this) — that's the common, accepted use.
2930
- ❌ Do not submit an SF-Symbol-derived icon to the App Store.
3031

3132
For the shipped icon, draw original artwork (see `examples/demo/` for a fully
3233
original clip-art clock) and feed that through the same pipeline.
3334

34-
## Why glassmith doesn't bundle a rendered symbol
35+
## What this repo commits, and what it doesn't
3536

36-
The `examples/sf-symbol/` example references `layers/symbol.png` but does **not**
37-
commit it (it's git-ignored). You generate it locally with the `sf` command. That
38-
keeps Apple's artwork out of this MIT-licensed repo and keeps the example honest
39-
about the restriction above.
37+
- The README hero is a **composited illustration** of an SF Symbol on glass —
38+
fine as documentation of what the tool does.
39+
- The `examples/sf-symbol/` example references `layers/symbol.png` but does
40+
**not** commit the raw layer (it's git-ignored). You generate it locally with
41+
the `sf` command, so the bare Apple glyph asset isn't redistributed here and
42+
the example stays honest about the restriction above.

0 commit comments

Comments
 (0)