Skip to content

Commit

Permalink
Fixes Badges Being Broken in the README (tgstation#77718)
Browse files Browse the repository at this point in the history
## About The Pull Request

This shit was broken:


![image](https://github.com/tgstation/tgstation/assets/34697715/94b49cf4-f624-4161-8cbe-bb15827e75e8)

Ew, the alt text is bad too. Anyways, this is because the badge servicer
we use has been down for the last two weeks, as detailed in
forthebadge/for-the-badge#252. There is no ETA on
getting the service back up, and I was able to use the trick detailed in
that issue in order to grab the SVGs of those images and then move those
to a folder in our repository, and then have the readme pull it from
there. **This has been stated to be okay by the project in their
repository's readme** btw, but I included an attributions page in the
new folder I made.

Much nicer to no longer have that external dependency. I also cleaned up
some other code (tied up the alt text, made the coverage more accurate,
etc. etc.). I'm not sure if it's worthwhile to also selfhost the comic
links (as well as potentially running awry of CC 3.0 regulations), but I
think this much is fine for now. You can see an example of this working
here: https://github.com/san7890/bruhstation/tree/readers#readme

I don't know if the service will ever come back again, but given that
it's been two weeks, I'm not really much willing to wait it out.
Self-hosting this stuff is poggers anyhow

## Changelog

Not Applicable
  • Loading branch information
san7890 authored Aug 19, 2023
1 parent 5132522 commit 3957b77
Show file tree
Hide file tree
Showing 7 changed files with 72 additions and 2 deletions.
8 changes: 8 additions & 0 deletions .github/images/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# Attributions

## Badges
`built-with-resentment.svg` and `contains-technical-debt.svg` were originally sourced from https://forthebadge.com/, with the repository located at https://github.com/BraveUX/for-the-badge. `made-in-byond.gif` is a user-generated modification of one of these badges provided by this service.

## Comics

Both comics are sourced from https://www.monkeyuser.com/, which gives permission for use in non-profit usage via https://www.monkeyuser.com/about/index.html. `bug_free.png` can be found at https://www.monkeyuser.com/2019/bug-free/, and the original version of `technical_debt.png` can be found at https://www.monkeyuser.com/2018/tech-debt/ (the version found in the folder has been modified).
30 changes: 30 additions & 0 deletions .github/images/badges/built-with-resentment.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
32 changes: 32 additions & 0 deletions .github/images/badges/contains-technical-debt.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .github/images/badges/made-in-byond.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .github/images/comics/106-tech-debt-modified.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .github/images/comics/131-bug-free.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@
[![Build Status](https://github.com/tgstation/tgstation/workflows/CI%20Suite/badge.svg)](https://github.com/tgstation/tgstation/actions?query=workflow%3A%22CI+Suite%22)
[![Percentage of issues still open](https://isitmaintained.com/badge/open/tgstation/tgstation.svg)](https://isitmaintained.com/project/tgstation/tgstation "Percentage of issues still open")
[![Average time to resolve an issue](https://isitmaintained.com/badge/resolution/tgstation/tgstation.svg)](https://isitmaintained.com/project/tgstation/tgstation "Average time to resolve an issue")
![Coverage](https://img.shields.io/badge/coverage---3%25-red.svg)
![Coverage](https://img.shields.io/badge/coverage---4%25-red.svg)

[![resentment](https://forthebadge.com/images/badges/built-with-resentment.svg)](https://www.monkeyuser.com/assets/images/2019/131-bug-free.png) [![resentment](https://forthebadge.com/images/badges/contains-technical-debt.svg)](https://user-images.githubusercontent.com/8171642/50290880-ffef5500-043a-11e9-8270-a2e5b697c86c.png) [![forinfinityandbyond](https://user-images.githubusercontent.com/5211576/29499758-4efff304-85e6-11e7-8267-62919c3688a9.gif)](https://www.reddit.com/r/SS13/comments/5oplxp/what_is_the_main_problem_with_byond_as_an_engine/dclbu1a)
[![resentment](.github/images/badges/built-with-resentment.svg)](.github/images/comics/131-bug-free.png) [![technical debt](.github/images/badges/contains-technical-debt.svg)](.github/images/comics/106-tech-debt-modified.png) [![forinfinityandbyond](.github/images/badges/made-in-byond.gif)](https://www.reddit.com/r/SS13/comments/5oplxp/what_is_the_main_problem_with_byond_as_an_engine/dclbu1a)

* **Website:** https://www.tgstation13.org
* **Code:** https://github.com/tgstation/tgstation
Expand Down

0 comments on commit 3957b77

Please sign in to comment.