GitXplorerGitXplorer
S

fail-badges

public
46 stars
10 forks
0 issues

Commits

List of commits on branch gh-pages.
Verified
44b12ecc6f7e346901eba263ca2d6266a84c3f26

Merge pull request #18 from edent/patch-1

SShawnHymel committed 3 years ago
Verified
e9b0ff40f46d5124de40f65ce09d84d39492cd36

Display badges on README

eedent committed 3 years ago
Unverified
2f5d57bd00da7fd528a8b6787f94a4e4f01aa83e

Added that S thingy

SShawnHymel committed 4 years ago
Unverified
eb2ee9caadf4d5a1eeb78b624c0063e6fd3eb536

updated url in json file

EESpitler committed 4 years ago
Unverified
19df62b365286eabc8fb33d3b7f44c5fbb529408

adjusted canvass size updated json url line

EESpitler committed 4 years ago
Verified
94f55f3e4d0bc13bd500d8ba6224366a7141e983

Merge pull request #16 from ShawnHymel/revert-15-gh-pages

SShawnHymel committed 4 years ago

README

The README file for this repository.

Fail Badges

Ever wanted to wear your fails like a badge of honor? Proud that you burned your hand with a soldering iron? Got TX/RX mixed up?

We're here for you, and we want to celebrate failures, because they're part of the learning process. We've all been there.

Download the SVG's for printing or put them on your website!

Badges

The compiler yelled at you for forgetting a close parenthesis.
Forgot to rotate the connector in the middle
You take your great product to the compliance lab and they dash your hopes of an easy pass with this graph
Your web page looks wonky because you forgot one of these.
You forgot to level the bed and your print failed!
Were you even paying attention, or were you just doodling on the desk?
You overvolted another board and let the magic smoke out!
The compiler yelled at you for forgetting a semicolon.
For those times when you've burned your hand with a soldering iron.
TX RX labels are evil.
TX RX labels are evil.
Forget to link grounds on different pcbs

How to Print Badges

TODO

How to Add Badge to Website

TODO

How to Submit Your Own Design

Badge designs must be in .SVG format and adhere to the Hex Stickers Standard. That way, they all have the same size and shape. Learn more about the hex sticker format here.

Badge dimensions

Use a program like Inkscape to create your design. We recommend starting with the hex image template found in the badges/ directory as a base.

  • Make sure you own the rights to the image you are submitting!
  • Clone this repo
  • Create a new folder in the badges/ directory with the name of your badge, using only lowercase letters, numbers, and hyphens
  • Give your .svg file a name using only lowercase letters, numbers, and hyphens
  • Add your .svg graphic and a meta.json file containing information about your design

Here is a meta.json template:

{
  "name": "txrx-fail",
  "author": "Shawn Hymel",
  "license": "CC0",
  "url": "https://raw.githubusercontent.com/ShawnHymel/fail-badges/gh-pages/badges/txrx-fail/txrx-fail.svg",
  "description": "Show that you've messed up the TX/RX wiring on a serial bus at least once!",
  "sticker_url": "(optional) add a url to an online store that will make and ship a sticker version of your badge"
}

Please be descriptive in the description! This should help people know what the badge represents.

When done, your directory structure should look like this:

fail-badges/
|- badges/
|--- my-badge/
|----- meta.json
|----- my-badge.svg
|----- ...
|--- ...
|- README.md

Make a pull request to this repo! See this guide for help on making pull requests.

Resources

Here are some tools that can help you automatically generate stickers:

License and Credits

See meta.json in each badge folder to view the license information for that particular sticker.

Sticker specifications, repo layout, and much code credits go to hexbin.