From 1adf7ffe3144edfc6aa32262db5b57b1371a99a2 Mon Sep 17 00:00:00 2001 From: Ruben Date: Fri, 9 May 2025 02:32:17 -0500 Subject: [PATCH 1/3] update sharkey logo documentation --- packages/frontend/assets/sharkey-text-src/README.md | 11 +++++++---- .../sharkey-text-src/{sharkey_v2.svg => sharkey.svg} | 0 2 files changed, 7 insertions(+), 4 deletions(-) rename packages/frontend/assets/sharkey-text-src/{sharkey_v2.svg => sharkey.svg} (100%) diff --git a/packages/frontend/assets/sharkey-text-src/README.md b/packages/frontend/assets/sharkey-text-src/README.md index 64b4557ccc..d88aeddb6f 100644 --- a/packages/frontend/assets/sharkey-text-src/README.md +++ b/packages/frontend/assets/sharkey-text-src/README.md @@ -1,7 +1,10 @@ -This logo text was made in Inkscape by @sneexy@booping.synth.download +# Sharkey Logo -If you edit it, you can use -[svgo](https://jakearchibald.github.io/svgomg/) to generate a -browser-compatible file, to replace `../sharkey.svg` +This logo was made in Inkscape by [@sneexy@booping.synth.download](https://booping.synth.download/@sneexy). + +The font used is Lilita One ([Google Fonts](https://fonts.google.com/specimen/Lilita+One)). + +The logo should preferably be modified using Inkscape, but should work in any other software. +If modifications were made using Inkscape, you should use [svgo](https://github.com/svg/svgo) ([Web UI](https://jakearchibald.github.io/svgomg), ensure `Multipass` is enabled) to produce an SVG compatible to be viewed in web browsers, which will replace then [`../sharkey.svg`](../sharkey.svg). This logo is distributed under the same licence as Sharkey (AGPL ≥3). diff --git a/packages/frontend/assets/sharkey-text-src/sharkey_v2.svg b/packages/frontend/assets/sharkey-text-src/sharkey.svg similarity index 100% rename from packages/frontend/assets/sharkey-text-src/sharkey_v2.svg rename to packages/frontend/assets/sharkey-text-src/sharkey.svg From 951cef82a775090694712cc7a3492949d6b5c912 Mon Sep 17 00:00:00 2001 From: Ruben Date: Fri, 9 May 2025 02:38:20 -0500 Subject: [PATCH 2/3] expand inkscape instructions --- packages/frontend/assets/sharkey-text-src/README.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/packages/frontend/assets/sharkey-text-src/README.md b/packages/frontend/assets/sharkey-text-src/README.md index d88aeddb6f..061185bed6 100644 --- a/packages/frontend/assets/sharkey-text-src/README.md +++ b/packages/frontend/assets/sharkey-text-src/README.md @@ -4,7 +4,12 @@ This logo was made in Inkscape by [@sneexy@booping.synth.download](https://boopi The font used is Lilita One ([Google Fonts](https://fonts.google.com/specimen/Lilita+One)). -The logo should preferably be modified using Inkscape, but should work in any other software. -If modifications were made using Inkscape, you should use [svgo](https://github.com/svg/svgo) ([Web UI](https://jakearchibald.github.io/svgomg), ensure `Multipass` is enabled) to produce an SVG compatible to be viewed in web browsers, which will replace then [`../sharkey.svg`](../sharkey.svg). +## Using Inkscape + +Preferably, you should use Inkscape when wanting to make modifications to the logo. Once you've made your edits, save the SVG here as is from Inkscape directly, then use [svgo](https://github.com/svg/svgo) ([Web UI](https://jakearchibald.github.io/svgomg), ensure `Multipass` is enabled) to produce an SVG compatible to be viewed in web browsers, which that file will then replace [`../sharkey.svg`](../sharkey.svg). + +## Not using Inkscape + +The logo should preferably be modified using Inkscape, but should work in any other software. If any weird issues appear, try opening it with Inkscape first or try using the version under [`../sharkey.svg`](../sharkey.svg) if you prefer to work with your software. Follow the instructions for Using Inkscape. This logo is distributed under the same licence as Sharkey (AGPL ≥3). From d5253eb2a394673bac9652541d1096b4be723089 Mon Sep 17 00:00:00 2001 From: Ruben Date: Fri, 9 May 2025 02:39:49 -0500 Subject: [PATCH 3/3] licence should be it's own header --- packages/frontend/assets/sharkey-text-src/README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/packages/frontend/assets/sharkey-text-src/README.md b/packages/frontend/assets/sharkey-text-src/README.md index 061185bed6..f153ec42e3 100644 --- a/packages/frontend/assets/sharkey-text-src/README.md +++ b/packages/frontend/assets/sharkey-text-src/README.md @@ -12,4 +12,6 @@ Preferably, you should use Inkscape when wanting to make modifications to the lo The logo should preferably be modified using Inkscape, but should work in any other software. If any weird issues appear, try opening it with Inkscape first or try using the version under [`../sharkey.svg`](../sharkey.svg) if you prefer to work with your software. Follow the instructions for Using Inkscape. +## Licence + This logo is distributed under the same licence as Sharkey (AGPL ≥3).