diff --git a/README.md b/README.md index d035c69..d17d1dc 100644 --- a/README.md +++ b/README.md @@ -141,8 +141,8 @@ A new public primitive needs exact numeric tests before a consumer depends on it Bug reports, security disclosures, and contribution guidelines are collected at [ateliersvg.com/support](https://ateliersvg.com/support/). -Atelier is maintained by Simon André. Sharing the package or -[starring it on GitHub](https://github.com/ateliersvg/layout) helps more than you would think. +Sharing the package or [starring it on GitHub](https://github.com/ateliersvg/layout) helps more +than you would think. ## License diff --git a/assets/logo/README.md b/assets/logo/README.md deleted file mode 100644 index 0e5ecd3..0000000 --- a/assets/logo/README.md +++ /dev/null @@ -1,35 +0,0 @@ -# Logo - -Lockups `ATELIER \ LAYOUT`, derives du logo Atelier. - -| Fichier | Boite | Contenu | -| --- | --- | --- | -| `lockup-h*.svg` | 660 x 180 | monogramme, wordmark, tagline, horizontal | -| `lockup-v*.svg` | 600 x 600 | monogramme au-dessus, wordmark, tagline | -| `wordmark-h*.svg` | 464 x 96 | wordmark seul | -| `mark*.svg` | 414 x 423 | monogramme seul | - -Le suffixe `-dark` porte un fond `#08090f`, `-light` un fond `#fdfaf3`. Sans suffixe, le -fond est transparent et le texte est calibre pour rester lisible sur clair comme sur sombre. - -## Usage - -Dans un README, servir la paire dark/light au theme du lecteur: - -```html - - - Atelier Layout - -``` - -Sur un fond dont vous ne maitrisez pas la couleur, utiliser la variante transparente -`lockup-h.svg`. - -## Contraintes - -- Ne pas recolorer le monogramme ni le gradient (`#00b0fc` vers `#5e4da1`). -- Ne pas separer le wordmark de sa barre oblique. -- Ne pas ajouter d'ombre portee. -- Le texte utilise `system-ui`: le rendu suit la machine du lecteur. Ne pas substituer - une webfont, ne pas convertir en ``. diff --git a/assets/logo/lockup-h-dark.svg b/assets/logo/lockup-h-dark.svg deleted file mode 100644 index 2756784..0000000 --- a/assets/logo/lockup-h-dark.svg +++ /dev/null @@ -1,10 +0,0 @@ - - - - - - - - ATELIER \ LAYOUT - RENDERER-AGNOSTIC LAYOUT PRIMITIVES - diff --git a/assets/logo/lockup-h-light.svg b/assets/logo/lockup-h-light.svg deleted file mode 100644 index 906cc80..0000000 --- a/assets/logo/lockup-h-light.svg +++ /dev/null @@ -1,10 +0,0 @@ - - - - - - - - ATELIER \ LAYOUT - RENDERER-AGNOSTIC LAYOUT PRIMITIVES - diff --git a/assets/logo/lockup-h.svg b/assets/logo/lockup-h.svg deleted file mode 100644 index 44cda2c..0000000 --- a/assets/logo/lockup-h.svg +++ /dev/null @@ -1,9 +0,0 @@ - - - - - - - ATELIER \ LAYOUT - RENDERER-AGNOSTIC LAYOUT PRIMITIVES - diff --git a/assets/logo/lockup-v-dark.svg b/assets/logo/lockup-v-dark.svg deleted file mode 100644 index bd74260..0000000 --- a/assets/logo/lockup-v-dark.svg +++ /dev/null @@ -1,9 +0,0 @@ - - - - - - - ATELIER \ LAYOUT - RENDERER-AGNOSTIC LAYOUT PRIMITIVES - diff --git a/assets/logo/lockup-v-light.svg b/assets/logo/lockup-v-light.svg deleted file mode 100644 index c464562..0000000 --- a/assets/logo/lockup-v-light.svg +++ /dev/null @@ -1,9 +0,0 @@ - - - - - - - ATELIER \ LAYOUT - RENDERER-AGNOSTIC LAYOUT PRIMITIVES - diff --git a/assets/logo/lockup-v.svg b/assets/logo/lockup-v.svg deleted file mode 100644 index 6cde62c..0000000 --- a/assets/logo/lockup-v.svg +++ /dev/null @@ -1,8 +0,0 @@ - - - - - - ATELIER \ LAYOUT - RENDERER-AGNOSTIC LAYOUT PRIMITIVES - diff --git a/assets/logo/mark-dark.svg b/assets/logo/mark-dark.svg deleted file mode 100644 index dffd9c9..0000000 --- a/assets/logo/mark-dark.svg +++ /dev/null @@ -1,6 +0,0 @@ - - - - - - diff --git a/assets/logo/mark-light.svg b/assets/logo/mark-light.svg deleted file mode 100644 index dcb833c..0000000 --- a/assets/logo/mark-light.svg +++ /dev/null @@ -1,6 +0,0 @@ - - - - - - diff --git a/assets/logo/mark.svg b/assets/logo/mark.svg deleted file mode 100644 index 287eabb..0000000 --- a/assets/logo/mark.svg +++ /dev/null @@ -1,5 +0,0 @@ - - - - - diff --git a/assets/logo/wordmark-h-dark.svg b/assets/logo/wordmark-h-dark.svg deleted file mode 100644 index 27a4c6e..0000000 --- a/assets/logo/wordmark-h-dark.svg +++ /dev/null @@ -1,7 +0,0 @@ - - - - - - ATELIER \ LAYOUT - diff --git a/assets/logo/wordmark-h-light.svg b/assets/logo/wordmark-h-light.svg deleted file mode 100644 index 88e0c0f..0000000 --- a/assets/logo/wordmark-h-light.svg +++ /dev/null @@ -1,7 +0,0 @@ - - - - - - ATELIER \ LAYOUT - diff --git a/assets/logo/wordmark-h.svg b/assets/logo/wordmark-h.svg deleted file mode 100644 index 31a235b..0000000 --- a/assets/logo/wordmark-h.svg +++ /dev/null @@ -1,6 +0,0 @@ - - - - - ATELIER \ LAYOUT - diff --git a/composer.json b/composer.json index 44dd7c7..fc7bdd8 100644 --- a/composer.json +++ b/composer.json @@ -3,7 +3,7 @@ "description": "Renderer-agnostic spatial composition primitives: geometry, box constraints, grids, text layout, and links between boxes", "license": "MIT", "type": "library", - "homepage": "https://github.com/ateliersvg/layout", + "homepage": "https://ateliersvg.com/layout/", "keywords": [ "layout", "spatial", @@ -21,7 +21,8 @@ "authors": [ { "name": "Simon André", - "email": "smn.andre@gmail.com" + "email": "smn.andre@gmail.com", + "homepage": "https://smnandre.dev" } ], "minimum-stability": "stable", @@ -53,10 +54,8 @@ } }, "scripts": { - "coverage": "vendor/bin/phpunit --coverage-text", "cs": "vendor/bin/php-cs-fixer fix --dry-run --diff --sequential", "cs:fix": "vendor/bin/php-cs-fixer fix", - "docs:images": "php examples/illustrations.php", "qa": [ "@cs", "@sa", @@ -64,8 +63,5 @@ ], "sa": "vendor/bin/phpstan analyse --memory-limit=-1", "test": "vendor/bin/phpunit" - }, - "scripts-descriptions": { - "docs:images": "Regenerate the documentation figures into docs/images (requires the sibling atelier/svg checkout)" } } diff --git a/docs/composition/stacks.md b/docs/composition/stacks.md index a1be7a9..e9bef4a 100644 --- a/docs/composition/stacks.md +++ b/docs/composition/stacks.md @@ -77,4 +77,4 @@ A spacer takes part in flex distribution exactly like `Frame::stretch()`, but ca ## Baseline Alignment -`alignToBaseline()` aligns children on the first text baseline instead of the box edge. It only changes anything when the children expose a baseline, which today means ](../text blocks. +`alignToBaseline()` aligns children on the first text baseline instead of the box edge. It affects children that expose a baseline, such as [`TextBlock`](../text.md); other children keep their top edge. diff --git a/docs/connections.md b/docs/connections.md index 0db10c5..1320939 100644 --- a/docs/connections.md +++ b/docs/connections.md @@ -91,9 +91,9 @@ M 100 40 L 140 40 L 140 80 L 180 80 If you already have solved rectangles, `ConnectionLabel::avoid()` skips occupied placements deterministically before falling back to the requested placement. See [Geometry](geometry/overview.md) for the `RectIndex` it takes. -## What Links Between Boxes Do Not Do +## Consumer Responsibilities -This package does not currently solve: +This package returns connection geometry. It does not provide: - graph ranking - obstacle avoidance @@ -102,7 +102,7 @@ This package does not currently solve: - label collision avoidance - arrowhead drawing -Those are still consumer responsibilities. A consumer takes the returned points and turns them into whatever its renderer draws. +The consumer turns the returned points into the paths, arrowheads, and other marks its renderer draws. ## Demo diff --git a/docs/getting-started.md b/docs/getting-started.md index c79d9ac..9743e89 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -79,20 +79,3 @@ Geometry helpers are pure values: they do not render, mutate, or depend on SVG. | draw an arrow between two boxes | [Connections](connections.md) | | wrap and measure a label | [Text And Inline Runs](text.md) | | build lanes, an axis strip, or a key | [Tracks, Bands And Legends](tracks-bands-legends.md) | - -## Demos - -The scripts in `examples/` are executable, small, and print concrete numbers, which makes solved geometry easy to inspect. - -```bash -php examples/composition-demo.php -php examples/connections-demo.php -php examples/composition-gallery.php -``` - -`composition-demo.php` combines a fixed canvas, an outer margin, grid padding, row and column tracks, a spanning title slot, bottom-aligned text, bounds around two solved items, and a link between them. - -`connections-demo.php` isolates links between boxes, printing the source rect, the target rect, the connection points, the label point, and the final tangent for arrowheads. - -`composition-gallery.php` writes a dashboard, an overlay board, and a connections board as SVG. They are deliberately renderer-light: the script asks `atelier/layout` for geometry, then writes plain SVG elements from the solved frames. Which part is layout and which part is rendering stays visible. -