search

HellRok / Taylor

A simple game engine built using raylib and mruby
https://www.taylormadetech.dev
MIT License
97 stars 6 forks source link

Rework README #29

Closed Chadowo closed 5 months ago

Chadowo commented 5 months ago

The current README is nice, but can be improved, both in contents and visually (a tiny bit more visually) IMHO. This PR aims to address that.

Changes

The most notable changes can be found right at the beginning:

image

  1. The title now is the Taylor logo, centered (the outline is for legibility on white theme).
  2. The badges now all follow the flat round style, plus there are two new ones.
  3. The links are now hyperlinks, separated by pipes.

Other minor changes include the new section at the the end that indicates the project's license (kinda standard for most projects) and some really minimal text changes and grammar fixes.

The build section is the most affected by the changes of all sections, since IMO the older one sounds kinda stiff and hard to follow. I'd love to hear your thoughts on it!

Logo

To get the logo for the README, I had to recreate it. It would be nice to have some sort of press kit for use in splash screens, title, website and other mediums. Like Love2D's or Defold's. I don't want to burden you with more tasks or anything but it's something nice that we could definitively do down the road :).

Some Inspiration

Here are some cool project READMEs that I've used for inspiration (taken from here):

HellRok commented 5 months ago

This looks absolutely fantastic! I love the changes to the build section, I didn't even consider using the detail element for hiding the long parts.

I'm wondering if we can use prefers-color-scheme as I'd like if the text could be fully black when in light mode but still fully white in dark mode as what you have looks awesome. A picture of the readme in lightmode showing the text as just outlined

Thank you again for your hard work, your PRs have really helped bring Taylor to the next level!

Chadowo commented 5 months ago

Thanks for the feedback!

I'm wondering if we can use prefers-color-scheme as I'd like if the text could be fully black when in light mode but still fully white in dark mode as what you have looks awesome.

Seems like we're in luck, I'll do the change promptly.

Thank you again for your hard work, your PRs have really helped bring Taylor to the next level!

NP, happy to help :)

Chadowo commented 5 months ago

@HellRok I changed some text in the README, along with the change you mentioned about dynamically changing the logo based on the user theme (f9909e0). If you're cool with how it currently then I think it would be ready for merging.

Chadowo commented 5 months ago

Also, here are the files for the logos I've made.

HellRok commented 5 months ago

Thanks for this, it looks amazing!