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

Updated README #841

Merged
merged 24 commits into from
May 7, 2022
Merged

Conversation

FriskTheFallenHuman
Copy link
Contributor

@FriskTheFallenHuman FriskTheFallenHuman commented Apr 14, 2022

This PR aims to improve the readme file by making the looks of it a little better, and easier for new users, also I had change the links to be rendered with Markdown compliant and state that UTMT is more than just UT/DR modding.

@Grossley you may want to activate the server widget in the discord server settings to the discord badge works perfectly.

EDIT: you may want to rebase this PR lol

Copy link
Contributor

@Miepee Miepee left a comment

Choose a reason for hiding this comment

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

Left a few review comments. Looks mostly good, just have some gripes with a few decisions.

.github/README.md Outdated Show resolved Hide resolved
.github/README.md Outdated Show resolved Hide resolved
.github/README.md Outdated Show resolved Hide resolved
.github/README.md Outdated Show resolved Hide resolved
.github/README.md Outdated Show resolved Hide resolved
.github/README.md Outdated Show resolved Hide resolved
.github/README.md Outdated Show resolved Hide resolved
.github/README.md Outdated Show resolved Hide resolved
.github/README.md Outdated Show resolved Hide resolved
.github/README.md Outdated Show resolved Hide resolved
.github/README.md Outdated Show resolved Hide resolved
.github/README.md Outdated Show resolved Hide resolved
Copy link
Contributor

@Miepee Miepee left a comment

Choose a reason for hiding this comment

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

found another thing

.github/README.md Outdated Show resolved Hide resolved
Copy link
Contributor

@Miepee Miepee left a comment

Choose a reason for hiding this comment

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

Two more things

.github/README.md Outdated Show resolved Hide resolved
.github/README.md Outdated Show resolved Hide resolved
@Miepee
Copy link
Contributor

Miepee commented May 1, 2022

@FriskTheFallenHuman why did you move the Readme to under the .github folder?

@FriskTheFallenHuman
Copy link
Contributor Author

@FriskTheFallenHuman why did you move the Readme to under the .github folder?

because functionality speaking still works

@NyakoFox
Copy link
Contributor

NyakoFox commented May 1, 2022

readme files are normally in the root so i think it should stay outside of the folder

@Miepee
Copy link
Contributor

Miepee commented May 1, 2022

Agree with Nyako, The .github folder should be for GitHub specific stuff.
A readme and images are not GitHub specific.

@FriskTheFallenHuman
Copy link
Contributor Author

Agree with Nyako, The .github folder should be for GitHub specific stuff. A readme and images are not GitHub specific.

https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-readmes i think you may be missinformed

@NyakoFox
Copy link
Contributor

NyakoFox commented May 1, 2022

I don't understand what the link is for; it just says that .github is another place you can put a readme in. I'm saying that it's not a good idea because most people put them in the root, and as Miepee says, .github is more for github specific things, while a readme isn't

@Archie-osu
Copy link
Contributor

Archie-osu commented May 1, 2022

Agree with Nyako, The .github folder should be for GitHub specific stuff. A readme and images are not GitHub specific.

https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-readmes i think you may be missinformed

The .github folder should indeed be used for GitHub specific things, like actions scripts, or the wiki (at least I'd put it there).

@Miepee
Copy link
Contributor

Miepee commented May 1, 2022

Yeah, I wasn't disputing that you can't put the Readme into .github.
I was saying, that in order to be more findable for users not necessarily visiting the project via GitHub and for organizational sake, it's better to have it in root.

@FriskTheFallenHuman
Copy link
Contributor Author

Yeah, I wasn't disputing that you can't put the Readme into .github. I was saying, that in order to be more findable for users not necessarily visiting the project via GitHub and for organizational sake, it's better to have it in root.

did you looked at my repo? do you see that the readme is still displaying regardless of its localization i don't know what are you trying to get functionality wise still works

@Miepee
Copy link
Contributor

Miepee commented May 1, 2022

From your answer, I don't think you read or understood what I said.
Whether it displays or not was never the point.

@FriskTheFallenHuman
Copy link
Contributor Author

From your answer, I don't think you read or understood what I said. Whether it displays or not was never the point.

i do what GitHub suggest

@Miepee
Copy link
Contributor

Miepee commented May 1, 2022

And GitHub suggests putting it into root. As determined by the behaviour that appears when you click on the "Add readme" button on a new project.

Copy link
Contributor

@Miepee Miepee left a comment

Choose a reason for hiding this comment

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

Noticed more stuff again

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md 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
@Grossley Grossley merged commit e74887f into UnderminersTeam:master May 7, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants