Custom Logo and Favicon

.github/workflows/generate-favicons.yml

@@ -0,0 +1,39 @@
+name: Logo and Favicon Generation
+
+on:
+  push:
+    paths:
+      - 'logo.svg'
+  workflow_dispatch:
+
+jobs:
+  make-favicons:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: install inkscape and open-sans
+        run: |
+          sudo apt-get update
+          sudo apt-get install inkscape fonts-open-sans -y
+
+      - name: checkout code
+        uses: actions/checkout@v3
+
+      - name: convert files
+        run: |
+          echo 'note inkscape version'
+          inkscape -V
+          echo 'commands will only work on inkscape older than 1.0'
+          echo 'see this stackoverflow post for more info'
+          echo 'https://stackoverflow.com/a/14174624'
+          inkscape -z -w 180 -h 180 logo.svg -e assets/apple-touch-icon.png
+          inkscape -z -w 32 -h 32 logo.svg -e assets/favicon-32.png
+          inkscape -z -w 192 -h 192 logo.svg -e assets/favicon-192.png
+
+      - name: commit changes
+        run: |
+          git config user.name github-actions
+          git config user.email [email protected]
+          git add .
+          git commit -m "update favicons"
+          git push

README.md

@@ -1,5 +1,6 @@
 [![GitHub release (latest by date)](https://img.shields.io/github/v/release/jchue/argon-webtrees-theme)](https://github.com/jchue/argon-webtrees-theme/releases/latest)
 [![webtrees major version](https://img.shields.io/badge/webtrees-v2.1.x-9cf)](https://webtrees.net/download)
+![GitHub Workflow Status](https://img.shields.io/github/workflow/status/tuetenk0pp/argon-webtrees-theme/Logo%20and%20Favicon%20Generation?label=favicon%20generation)
 
 # Argon Theme for webtrees
 
@@ -31,9 +32,11 @@ webtrees 2.1.x (see [prior releases](https://github.com/jchue/argon-webtrees-the
 4. Upload the folder into the `modules_v4` directory of the webtrees installation on your web server.
 5. Ensure the theme is enabled in your Control panel.
 
+**Optional Step:** If you would like to use the alternative logo ([`logo.svg`](./logo.svg)), replace the apple-touch-icon.png and favicon-files you find in the web root and public directories with the respective files you find in the [assets directory](./assets/) in this repository.
+
 ## Structure
 
-Because webtrees 2 is built with Bootstrap by default, the majority of this theme is just a matter of applying the Argon stylesheet. 
+Because webtrees 2 is built with Bootstrap by default, the majority of this theme is just a matter of applying the Argon stylesheet.
 
 Additionally, there are a handful of opinionated changes, mostly regarding sizing and spacing, requiring some views to be overwritten. Most of these are achieved with a simple replacement function to add/remove/modify classes and elements. Therefore, when a change is introduced in the webtrees codebase, these views should adopt them accordingly unless there is a drastic change to the template.
 
@@ -81,4 +84,4 @@ To support Sass and ECMAScript, the stylesheets and scripts are developed in the
 npm run build
 ```
 
-This will compile/transpile the stylsheets/scripts and package them, along with the PHP views, in a `dist/` directory.
+This will compile/transpile the stylsheets/scripts and package them, along with the PHP views, in a `dist/` directory.