From 91844a012a6414bdf0d5e0c6ce92e8e2c2574230 Mon Sep 17 00:00:00 2001 From: Pierre-Louis Date: Thu, 28 Aug 2025 09:18:36 +0200 Subject: [PATCH 1/6] consolidate and improve generator README --- packages/google_fonts/CONTRIBUTING.md | 8 -------- packages/google_fonts/generator/README.md | 9 ++++++--- 2 files changed, 6 insertions(+), 11 deletions(-) delete mode 100644 packages/google_fonts/CONTRIBUTING.md diff --git a/packages/google_fonts/CONTRIBUTING.md b/packages/google_fonts/CONTRIBUTING.md deleted file mode 100644 index 0fdf1e6f162e..000000000000 --- a/packages/google_fonts/CONTRIBUTING.md +++ /dev/null @@ -1,8 +0,0 @@ -## Updating the fonts - -If you notice fonts that are on [fonts.google.com](https://fonts.google.com) that do not appear in -this package, it means that the generator needs to be run. The generator will -check [fonts.google.com](https://fonts.google.com) for any new fonts, manually test each URL, and -regenerate the dart code. - -To run it manually, run `dart generator/generator.dart`. diff --git a/packages/google_fonts/generator/README.md b/packages/google_fonts/generator/README.md index cc488b1f8205..d1038125538d 100755 --- a/packages/google_fonts/generator/README.md +++ b/packages/google_fonts/generator/README.md @@ -1,7 +1,10 @@ -Generates the `GoogleFonts` class, list of supported families. +If you notice fonts that are on [fonts.google.com](https://fonts.google.com) that do not appear in +this package, it means that the generator needs to be run. The generator will +check [fonts.google.com](https://fonts.google.com) for new fonts, test the validity each URL, and +regenerate most dart code (e.g. `GoogleFonts` class), and [families_supported](./families_supported). -1. Navigate to the root directory of this project. +1. Navigate to the root directory of this project ([packages/google_fonts](..)). 2. `dart generator/generator.dart` -See generator/families\_diff for a summary of changes, which is useful when +After generation, see [generator/families_diff](generator/families_diff) for a summary of changes, which is useful when generating CHANGELOG.md entries. From fd80e8ca20ffa970e6a9cba59efb3a6ecca0cfbc Mon Sep 17 00:00:00 2001 From: Pierre <6655696+guidezpl@users.noreply.github.com> Date: Thu, 28 Aug 2025 09:42:34 +0200 Subject: [PATCH 2/6] Clarity Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> --- packages/google_fonts/generator/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/google_fonts/generator/README.md b/packages/google_fonts/generator/README.md index d1038125538d..2d508b132365 100755 --- a/packages/google_fonts/generator/README.md +++ b/packages/google_fonts/generator/README.md @@ -1,6 +1,6 @@ If you notice fonts that are on [fonts.google.com](https://fonts.google.com) that do not appear in this package, it means that the generator needs to be run. The generator will -check [fonts.google.com](https://fonts.google.com) for new fonts, test the validity each URL, and +check [fonts.google.com](https://fonts.google.com) for new fonts, validate each URL, and regenerate most dart code (e.g. `GoogleFonts` class), and [families_supported](./families_supported). 1. Navigate to the root directory of this project ([packages/google_fonts](..)). From 239631390023a08ca2a00ee39810735a6b5fb251 Mon Sep 17 00:00:00 2001 From: Pierre <6655696+guidezpl@users.noreply.github.com> Date: Thu, 28 Aug 2025 09:42:54 +0200 Subject: [PATCH 3/6] Fix link Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> --- packages/google_fonts/generator/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/google_fonts/generator/README.md b/packages/google_fonts/generator/README.md index 2d508b132365..8f645b8e994f 100755 --- a/packages/google_fonts/generator/README.md +++ b/packages/google_fonts/generator/README.md @@ -6,5 +6,5 @@ regenerate most dart code (e.g. `GoogleFonts` class), and [families_supported](. 1. Navigate to the root directory of this project ([packages/google_fonts](..)). 2. `dart generator/generator.dart` -After generation, see [generator/families_diff](generator/families_diff) for a summary of changes, which is useful when +After generation, see [families_diff](families_diff) for a summary of changes, which is useful when generating CHANGELOG.md entries. From 970692a1cd50a97a1b85466b92e4d499fe44a7dd Mon Sep 17 00:00:00 2001 From: Pierre-Louis Date: Thu, 28 Aug 2025 13:56:11 +0200 Subject: [PATCH 4/6] add back contributing --- packages/google_fonts/CONTRIBUTING.md | 2 ++ packages/google_fonts/generator/README.md | 10 +++++----- 2 files changed, 7 insertions(+), 5 deletions(-) create mode 100644 packages/google_fonts/CONTRIBUTING.md diff --git a/packages/google_fonts/CONTRIBUTING.md b/packages/google_fonts/CONTRIBUTING.md new file mode 100644 index 000000000000..c8fd01ec7781 --- /dev/null +++ b/packages/google_fonts/CONTRIBUTING.md @@ -0,0 +1,2 @@ +If you notice fonts that are on [fonts.google.com](https://fonts.google.com) that do not appear in +this package, it means that the [generator](./generator/README.md) needs to be run to update the package. diff --git a/packages/google_fonts/generator/README.md b/packages/google_fonts/generator/README.md index 8f645b8e994f..f07030b378dd 100755 --- a/packages/google_fonts/generator/README.md +++ b/packages/google_fonts/generator/README.md @@ -1,10 +1,10 @@ -If you notice fonts that are on [fonts.google.com](https://fonts.google.com) that do not appear in -this package, it means that the generator needs to be run. The generator will -check [fonts.google.com](https://fonts.google.com) for new fonts, validate each URL, and -regenerate most dart code (e.g. `GoogleFonts` class), and [families_supported](./families_supported). +The generator will check [fonts.google.com](https://fonts.google.com) for new fonts, validate each URL, and +regenerate most Dart code (e.g. `GoogleFonts` class), and [families_supported](./families_supported). + +Note: Googlers only, pending b/280786655, there is an additional prerequisite step required of the Google Fonts team 1. Navigate to the root directory of this project ([packages/google_fonts](..)). 2. `dart generator/generator.dart` After generation, see [families_diff](families_diff) for a summary of changes, which is useful when -generating CHANGELOG.md entries. +generating `CHANGELOG.md` entries. From 2488bf3851bf20e21e1004e4d73b16455537dbe8 Mon Sep 17 00:00:00 2001 From: Pierre-Louis Date: Mon, 1 Sep 2025 11:39:08 +0200 Subject: [PATCH 5/6] Remove link --- packages/google_fonts/generator/README.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/packages/google_fonts/generator/README.md b/packages/google_fonts/generator/README.md index f07030b378dd..34c2f3d6898b 100755 --- a/packages/google_fonts/generator/README.md +++ b/packages/google_fonts/generator/README.md @@ -6,5 +6,4 @@ Note: Googlers only, pending b/280786655, there is an additional prerequisite st 1. Navigate to the root directory of this project ([packages/google_fonts](..)). 2. `dart generator/generator.dart` -After generation, see [families_diff](families_diff) for a summary of changes, which is useful when -generating `CHANGELOG.md` entries. +After generation, see the `families_diff` file for a summary of changes, which can be useful for writing `CHANGELOG.md` entries. From 67ae79cde20fed6f35d8d1f0b4afdfe5f7a1bc69 Mon Sep 17 00:00:00 2001 From: Kate Lovett Date: Thu, 4 Sep 2025 14:12:43 -0500 Subject: [PATCH 6/6] Apply suggestion from @Piinks --- packages/google_fonts/generator/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/google_fonts/generator/README.md b/packages/google_fonts/generator/README.md index 34c2f3d6898b..c2f981c32243 100755 --- a/packages/google_fonts/generator/README.md +++ b/packages/google_fonts/generator/README.md @@ -1,7 +1,7 @@ The generator will check [fonts.google.com](https://fonts.google.com) for new fonts, validate each URL, and regenerate most Dart code (e.g. `GoogleFonts` class), and [families_supported](./families_supported). -Note: Googlers only, pending b/280786655, there is an additional prerequisite step required of the Google Fonts team +Note: Googlers only, pending b/280786655, there is an additional prerequisite step required. Contact the Google Fonts team from the linked issue. 1. Navigate to the root directory of this project ([packages/google_fonts](..)). 2. `dart generator/generator.dart`