From 4a9b430702bc6082426b50ecc3a06362b5720796 Mon Sep 17 00:00:00 2001 From: undergroundwires Date: Thu, 25 Jan 2024 01:19:31 +0100 Subject: [PATCH] Update documentation for `logo-update.js` script - Remove bash shebang from the JavaScript file. - Add documentation on top of the script file. --- scripts/logo-update.js | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/scripts/logo-update.js b/scripts/logo-update.js index 59964544..93e4d961 100644 --- a/scripts/logo-update.js +++ b/scripts/logo-update.js @@ -1,4 +1,15 @@ -#!/usr/bin/env bash +/** + * Description: + * This script updates the logo images across the project based on the primary + * logo file ('img/logo.svg' file). + * It handles the creation and update of various icon sizes for different purposes, + * including desktop launcher icons, tray icons, and web favicons from a single source + * SVG logo file. + * + * Usage: + * node ./scripts/logo-update.js + */ + import { resolve, join } from 'node:path'; import { rm, mkdtemp, stat } from 'node:fs/promises'; import { spawn } from 'node:child_process';