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

docs: Update README.md #15839

Merged
merged 1 commit into from Apr 4, 2024
Merged

docs: Update README.md #15839

merged 1 commit into from Apr 4, 2024

Conversation

turicfr
Copy link
Contributor

@turicfr turicfr commented Apr 2, 2024

  • Mention the Android application of Ruffle and link to its build instructions
  • Add missing folders in the sructure section
  • Misc changes

README.md Outdated

### Desktop

If you are building for a Linux platform, the following are typical dependencies:
#### Ubuntu
#### Linux prerequisites
Copy link
Contributor

Choose a reason for hiding this comment

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

Strictly speaking, some of these are general linux prerequisites - not specifically desktop.
I know that's not new to this PR though :D

Copy link
Member

Choose a reason for hiding this comment

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

Might be worth it to add a note that these are Ubuntu packages and that the names might not match with other flavors of Linux (e.g. Fedora), just for example #14654 (comment).

Copy link
Contributor Author

@turicfr turicfr Apr 3, 2024

Choose a reason for hiding this comment

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

I'm not a Linux expert, but I know that at least Arch depends on alsa-lib, openssl, zlib, and libxcb. Might worth adding these as well?

Also, we might also want to delete default-jre-headless from the list as Java is already present in the general prerequisites.

Copy link
Member

Choose a reason for hiding this comment

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

I'm not a Linux expert, but I know that at least Arch depends on alsa-lib, openssl, zlib, and libxcb. Might worth adding these as well?

libasound2 should be equivalent to alsa-lib, I think it might be worth it to have separate lists for different flavors.

Also, we might also want to delete default-jre-headless from the list as Java is already present in the general prerequisites.

I think we can keep it in, no harm mentioning it twice, just in case the reader missed it the first time.

Copy link
Contributor

@Dinnerbone Dinnerbone left a comment

Choose a reason for hiding this comment

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

Teeny tiny nit but otherwise thank you so much!

README.md Outdated Show resolved Hide resolved
Copy link
Contributor

@Dinnerbone Dinnerbone left a comment

Choose a reason for hiding this comment

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

Thank you!

* Mention the Android application of Ruffle and link to its build
instructions
* Add missing folders in the sructure section
* Misc changes
@Dinnerbone Dinnerbone merged commit eec5f9c into ruffle-rs:master Apr 4, 2024
15 checks passed
@turicfr turicfr deleted the update_readme branch April 4, 2024 20:02
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

3 participants