Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

modernises the readme and makes it considerably prettier #6325

Merged
merged 10 commits into from
May 24, 2024

Conversation

harryob
Copy link
Member

@harryob harryob commented May 23, 2024

infinite thanks to ParadiseSS13/Paradise#25259 for a lot of the nice formatting here

the icons here (aside from the logo) are made by me, using font awesome (free) icons

preview it here! https://github.com/harryob/cmss13/tree/new-readme

@github-actions github-actions bot added Github We don't really know what else this belongs to Missing Changelog Maintainers always document their changes. labels May 23, 2024
Copy link
Contributor

@Drulikar Drulikar left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I sort of wanted some better indication for the headers to be links since somereason github doesn't underline them. But doing <ins></ins> on the link then would look funky with the subheading line. Past that was considering https://fontawesome.com/icons/arrow-up-right-from-square?f=classic&s=solid at the end of them, but then it'd seem like you should use that for all links, so I dunno its fine as is.

For me the first time looking at the page I was going to suggest you should add Guide to Git, because my attention was drawn more to the tip for the Guide to Contributing instead of the header's link. But I probably should just edit that article to better highlight guide to git on that page since all contributors need to follow those steps. It in a little git section doesn't make it seem relevant or important to contributing.

@Drulikar Drulikar added this pull request to the merge queue May 24, 2024
Merged via the queue into cmss13-devs:master with commit 54d2675 May 24, 2024
28 checks passed
@Drulikar Drulikar mentioned this pull request Jun 3, 2024
harryob pushed a commit that referenced this pull request Jun 3, 2024
# About the pull request

This PR is a follow up to #6325 fixing a couple broken links.

# Changelog

No player facing changes.
Git-Nivrak pushed a commit to Git-Nivrak/cmss13 that referenced this pull request Jun 9, 2024
# About the pull request

This PR is a follow up to cmss13-devs#6325 fixing a couple broken links.

# Changelog

No player facing changes.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Github We don't really know what else this belongs to Missing Changelog Maintainers always document their changes.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants