Skip to content

Commit

Permalink
Clarify badges guide
Browse files Browse the repository at this point in the history
  • Loading branch information
Sendouc committed Oct 6, 2024
1 parent bed4548 commit 80a1d3f
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions docs/badges.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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)

Expand Down

0 comments on commit 80a1d3f

Please sign in to comment.