Skip to content

Commit

Permalink
Update documentation for logo-update.js script
Browse files Browse the repository at this point in the history
- Remove bash shebang from the JavaScript file.
- Add documentation on top of the script file.
  • Loading branch information
undergroundwires committed Mar 24, 2024
1 parent ac17693 commit 4a9b430
Showing 1 changed file with 12 additions and 1 deletion.
13 changes: 12 additions & 1 deletion scripts/logo-update.js
Original file line number Diff line number Diff line change
@@ -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';
Expand Down

0 comments on commit 4a9b430

Please sign in to comment.