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.

Sign up for GitHub

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

Jump to bottom

Update README.md #813

Merged
merged 10 commits into from Mar 20, 2024
Merged

Update README.md #813

merged 10 commits into from Mar 20, 2024

Conversation

its-miroma
Copy link
Contributor

@its-miroma its-miroma commented Feb 29, 2024 •
edited

I'm creating a new PR to fix the problems with the linter from #812.

Preview at https://github.com/its-miroma/fo/tree/readme

  • Add right-aligned FO icon
  • Add Table of Contents
  • Change "Launcher Comparison" table
    • Flip rows and columns, because items (Launchers) are usually placed as rows, plus if hypothetically there was a new one that would give a one-line diff
    • Remove "Can be used offline" column, because all launchers support that, and specified that above
    • Remove "Windows, macOS, Linux support" column, for the same reason
    • Remove "Unique feature" column, because I think FO, and especially this README.md, is not the right place to see which features launchers have
    • Place the table in a collapsible block
    • Add launcher icons?
  • Add "Resource Packs" section, with links to download them.
  • Add "Contribute" section, linking to https://download.fo/thanks
  • Merge CREDITS.md into "Credits" section
  • Merge Resource Packs/README.md into "Resource Packs" section
  • Use reference links which help readability of the source file and make it more maintainable
  • Add badges
    • Enable Discord widget
  • Move INCLUDED-MODS.md to the wiki?
  • Add MultiMC auto update information
    • Move MultiMC auto update to the wiki?
  • Update DEVELOPER-README.md
    • Perhaps move to CONTRIBUTING.md?
    • Add link to "Contributing" section in README.md
    • Add link to CODE_OF_CONDUCT.md in CONTRIBUTING.md
    • Add link to CODE_OF_CONDUCT.md to the wiki?

Kichura
Kichura reviewed Feb 29, 2024
View reviewed changes
Copy link
Member

@Kichura Kichura left a comment

Choose a reason for hiding this comment

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

note to self, the commit title does not mention that credits file + resource pack folder's readme was cut - consider this a note rather than review lol.

@its-miroma
Copy link
Contributor Author

its-miroma commented Mar 2, 2024 •
edited

I added the badges, using shields.io, but to add custom
icons I had to embed a data URI, which is a little ugly
in the source code.

I used the flat style, but if you prefer, shields.io
also supports the for-the-badge style.

There's also a problem with the Discord badge, because
the server widget is not enabled in the FO server.

I also re-added the MultiMC download links.

Madis0
Madis0 requested changes Mar 3, 2024
View reviewed changes
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 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
@Madis0
Copy link
Member

Madis0 commented Mar 3, 2024

Is there a distinct icon for light/dark mode?

No.

Update DEVELOPER-README.md
Perhaps move to CONTRIBUTING.md?

Maybe... Right now the contributing page highlights things that can be done by most users, while developer-readme is for specifically those who fork FO. Therefore I am not sure those should be mixed, as the target audiences are different.

its-miroma
its-miroma commented Mar 4, 2024
View reviewed changes
README.md Show resolved Hide resolved
@its-miroma its-miroma requested a review from Madis0 March 4, 2024 13:18
@its-miroma its-miroma marked this pull request as ready for review March 4, 2024 13:34
@its-miroma
Copy link
Contributor Author

its-miroma commented Mar 6, 2024 •
edited

I forgot to ask: title, icon and badges can be centered
in the page, so which style do you prefer:

osfanbuff63
osfanbuff63 reviewed Mar 7, 2024
View reviewed changes
README.md Outdated Show resolved Hide resolved
@Madis0
Copy link
Member

Madis0 commented Mar 11, 2024

I forgot to ask: title, icon and badges can be centered in the page, so which style do you prefer:

* https://github.com/its-miroma/fo/tree/readme (current)

* https://github.com/its-miroma/fo/tree/readme-alt (centered)

I prefer the centered one.

@its-miroma its-miroma force-pushed the readme branch 3 times, most recently from 8a64ca0 to 1de65c0 Compare March 19, 2024 20:25
Madis0
Madis0 requested changes Mar 20, 2024
View reviewed changes
Copy link
Member

@Madis0 Madis0 left a comment •
edited

Choose a reason for hiding this comment

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

I think these are the last changes before I can merge it, unless you want to add something more

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
Madis0
Madis0 reviewed Mar 20, 2024
View reviewed changes
README.md Outdated Show resolved Hide resolved
@its-miroma
Update README.md
0c5610e 
(Also merge `CREDITS.md` and `Resource Packs/README.md` in `README.md`)
@its-miroma
Add MultiMC auto-update download links
e633b04 
Undo headings change by linter (did I mention that I hate my linter?)
@its-miroma
Add Table of Contents
debc3f6
@its-miroma
Add badges
1a252a2
@its-miroma
Apply review by @Madis0
df14922 
- Change wording to `Go download.fo`
- Change `Read the Wiki` badge
- Change `Support and Contribute!` badge
- Change `Help us Translate` badge, because it doesn't link to Crowdin
- Change `Discord` badge to show total members
- Remove Table of Contents
- Fix redundancy in "Download"
- Remove GitHub Releases from table because it's not a launcher
- Remove "MultiMC auto-update" section
- Highlight link to Thanks! page in "Contribute"
- Update "Credits"
@its-miroma
Apply review by @Madis0
53842f8 
- Change wording to `Official Website`
- Remove `!` from `Support and Contribute`
- Make the `Translate` badge monochrome
- Change `Resource Packs` section to a collapsible block
- Add "Credits" section replacing the "Contribute" section
@its-miroma
Use for-the-badge style
5904178
@its-miroma
Apply review by @osfanbuff63, @Madis0
cd570a9 
- Center the title
- Fix "Mod list" typo
- Correct "MultiMC auto-update" in table
- Add footnotes for the table
- Add icons and colors to badges
@its-miroma
Apply review by @Madis0
e59763f 
- Refactor `url-thanks` to `url-contribute`
- Refactor "Options changed" to "Changed Options"
- Remove manual word wrap
- Remove mention of GitHub Releases
- Use reference links in the "Credits" section
- Fix `url-wiki`
@its-miroma its-miroma requested a review from Madis0 March 20, 2024 19:44
@Madis0 Madis0 merged commit d396ede into Fabulously-Optimized:main Mar 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Kichura Kichura Kichura left review comments

@osfanbuff63 osfanbuff63 osfanbuff63 left review comments

@Madis0 Madis0 Madis0 approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
4 participants
@its-miroma @Madis0 @Kichura @osfanbuff63