From 80a1d3f400ec4c2ebe978e7c7a9fbbc353b9c803 Mon Sep 17 00:00:00 2001 From: Kalle <38327916+Sendouc@users.noreply.github.com> Date: Sun, 6 Oct 2024 13:49:37 +0300 Subject: [PATCH] Clarify badges guide --- docs/badges.md | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/docs/badges.md b/docs/badges.md index de7fa9403..6c518cf7f 100644 --- a/docs/badges.md +++ b/docs/badges.md @@ -26,6 +26,7 @@ Any badge to be added has to follow these rules. Badges that do not follow the r 1. First badge needs to be made - 3D artists can use [picoCAD](https://johanpeitz.itch.io/picocad) +- Some quick guide to picoCAD can be found pinned in the #badges Discord channel - Others can use the "[badges" Discord channel](https://discord.gg/sendou) to inquire about a commission - Read rules from above carefully at this point and ask if you do not understand something 2. Create needed files @@ -34,12 +35,17 @@ Any badge to be added has to follow these rules. Badges that do not follow the r - .avif file (static). Create via e.g. [Squoosh](https://squoosh.app/) from the .png file - All files should be squares. 512x512 is a good size for example 3. Make a pull request to the project -- You can request someone to help you on the ["development" Discord channel](https://discord.gg/sendou) +- If you don't know how a pull request is made you can ask someone you know that is familiar with GitHub or refer to the guide pinned in the #badges Discord channel - In the PR add the 3 needed files to public/static-assets/badges folder: ![alt text](img/badges-1.png) -- Also update app/features/badges/homemade.ts file (read the comments to understand each value): +- Also update app/features/badges/homemade.ts file (read the comments to understand each value) +- Note the file name should not contain spaces or big letters: + +❌ paddling pool.gif +❌ PaddlingPool.gif +✅ paddling-pool.gif ![alt text](img/badges-2.png)