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

Rename readme.txt to README.md & update links #181

Merged
merged 1 commit into from
Feb 18, 2020

Conversation

ashleydavies
Copy link
Contributor

GitHub natively renders this file without any changes very nicely as a Markdown file, whereas it's currently rendering it in plaintext

See:
https://github.com/SFML/SFML.Net/blob/master/readme.txt
https://github.com/SFML/SFML.Net/blob/76f05c206da7f021f63797c28023ed59a2ec6215/README.md

@ashleydavies
Copy link
Contributor Author

Also added a Travis badge to help identify where the CI is hosted at, although very happy to undo that if it's not a desired change!

@eXpl0it3r
Copy link
Member

I believe it makes sense to align it with how the official SFML repo looks like. 👍

But since we're already using Markdown, might make sense to actually transform the URLs to text links.

@ashleydavies
Copy link
Contributor Author

Thanks for the very prompt responses! Just updated the rest of the text links

@eXpl0it3r eXpl0it3r added the Feature New functionality or extending of an existing one label Feb 16, 2020
@ashleydavies ashleydavies changed the title Rename readme.txt to README.md Rename readme.txt to README.md & update links Feb 16, 2020
@DemoXinMC
Copy link
Contributor

All the changes seems fine, I would like to see the commits squashed, personally. Other than that, 👍

Copy link
Member

@eXpl0it3r eXpl0it3r left a comment

Choose a reason for hiding this comment

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

Not really your fault, but the README hasn't been updated in a while, sooo a few smaller changes are desired 😅

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@ashleydavies
Copy link
Contributor Author

No worries! Think that's all fixed now

@ashleydavies
Copy link
Contributor Author

Actually hold on this, I just realised there are links to this file within the repo so will fix those

@ashleydavies
Copy link
Contributor Author

All good, there was just the one

README.md Outdated Show resolved Hide resolved
Copy link
Member

@eXpl0it3r eXpl0it3r left a comment

Choose a reason for hiding this comment

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

Ah just as I thought it was done, I saw some minor things again 🙈

README.md Outdated Show resolved Hide resolved
@ashleydavies
Copy link
Contributor Author

Just fixed those, will squash later when I get home from work

@eXpl0it3r
Copy link
Member

Any chance to get it squashed? :)

@ashleydavies
Copy link
Contributor Author

Sorry, lost track of time -- squashed now 😅

@eXpl0it3r eXpl0it3r merged commit be1bd73 into SFML:master Feb 18, 2020
@ashleydavies ashleydavies deleted the patch-1 branch February 19, 2020 11:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Feature New functionality or extending of an existing one
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants