From dad56b13249b1f74cf0d53a98b7f48d25ca50ee9 Mon Sep 17 00:00:00 2001 From: Mike van Veenhuijzen Date: Mon, 26 Feb 2024 16:39:51 +0100 Subject: [PATCH] fix: add generate-pwa-assets instructions --- platforms/web/README.md | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/platforms/web/README.md b/platforms/web/README.md index 988356942..06864c9ab 100644 --- a/platforms/web/README.md +++ b/platforms/web/README.md @@ -10,8 +10,20 @@ - Lint through `yarn lint` (eslint, prettier, stylelint and tsc checks) - Run `yarn start` +## Create favicons / pwa icons + +First override the source icon with another image here [./public/images/icons/app-icon.png`](./public/images/icons/app-icon.png) +Use a high quality image square-sized image. We suggest a dimension 1024x1024 or higher + +- Navigate to the platform directory `cd platforms/web` +- Perform `yarn generate-pwa-assets` + +Instal `sharp` if you get the following error: Could not load the "sharp" module using the ... runtime. +And run `yarn generate-pwa-assets` afterwards + +The different icon formats are defined here [pwa-assets.config.ts](./pwa-assets.config.ts) + ## Developer guidelines - Read the workspace guidelines here [../../docs/developer-guidelines.md](../../docs/developer-guidelines.md). - Read the web platform guidelines here [./docs/developer-guidelines.md](./docs/developer-guidelines.md). -