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

Linux metadata files #20

Closed
3 tasks
Eonfge opened this issue Aug 24, 2022 · 8 comments
Closed
3 tasks

Linux metadata files #20

Eonfge opened this issue Aug 24, 2022 · 8 comments
Labels
build related Tags for build related issues, discussions and requests

Comments

@Eonfge
Copy link

Eonfge commented Aug 24, 2022

Hey Cemu!,

Cool to see that your project is going Open Source. It's very admirable and I hope that you'll not be completely crushed under all the feedback and comments you're getting. That said, I do have my own comments to add.

Linux metadata

With Linux support now being a very viable option, it's important to also have some stuff in place for the Linux ecosystem at large. For start, there are certain standards that most Linux distributions and Desktop Environments adhere to:

https://www.freedesktop.org/wiki/Specifications/

Stop reading now! It's way too much to tackle all at once, so let's help you in breaking it down a bit.

info.cemu.Cemu.desktop

This is the file that tells desktop environments like KDE and GNOME, that your binary is actually an application that the user should see in the UI. It uses tags and descriptions for filtering.

Example

info.cemu.Cemu.appdate.xml

This is a big XML that gives an explanation about the application, that has information about the developer, and that even provides links for help documentation, code contributions or donations. Also important, flatpaks on Flathub must have license information and age-ratings information, so that user's know what is coming to them.

Example

info.cemu.Cemu.svg

An icon. While it's not critical... svg is recommended since the days of 32px icons are numbered.

Example

Summary

  • .desktop
  • .appdata.xml
  • .svg
@Eonfge
Copy link
Author

Eonfge commented Aug 24, 2022

I was not aware of it, but this got previously mentioned in a comment #1 (comment) but perhaps it's best to track this as a separate issue.

@Eonfge
Copy link
Author

Eonfge commented Aug 24, 2022

Existing pull requests;

@Eonfge
Copy link
Author

Eonfge commented Aug 24, 2022

@JakobDev Great work with the metadata details. The only comment I have, is that it's customary (~70%) to capitalize the name of the application.

  • org.gnome.Lollypop
  • org.musicbrainz.Picard
  • com.github.Flacon

The rule is not absolute, and there are packages that don't do it

  • org.mozilla.firefox
  • org.kde.kid3
  • org.qbittorrent.qBittorrent

The Cemu project will have to decide on this, so let's give em a breather.

Another thing that we might want to do directly; Automatically install these files in the right directories when building with CMAKE

@JakobDev
Copy link
Contributor

JakobDev commented Aug 24, 2022

I also think the Devs should decide what they like more. Both is valid.

Another thing that we might want to do directly; Automatically install these files in the right directories when building with CMAKE

I agree, but I don't have much experience with CMake, so I don't know how to do that. Otherwise I would have it included in the PR. Probably @Zopolis4, who is currently refactoring the CMake files in #9 is the right person for this Job.,

@Zopolis4
Copy link
Contributor

Sure! I'll take a look

@craigbarnes
Copy link

craigbarnes commented Aug 25, 2022

... it's customary (~70%) to capitalize the name of the application.

@Eonfge The AppStream spec for <id/> recommends not doing that though:

Additionally, even though uppercase letters are permitted in a component-ID, it is strongly encouraged to only use lowercase letters for the ID.

@Eonfge
Copy link
Author

Eonfge commented Aug 26, 2022

@Eonfge The AppStream spec for <id/> recommends not doing that though:

I had no idea. I stand corrected. In that case, Cemu can roll both ways

@Crementif Crementif added the build related Tags for build related issues, discussions and requests label Aug 27, 2022
@j8r
Copy link

j8r commented Oct 16, 2022

Can be closed, most of the points are resolved now.
I'll make a PR to have a better quality image.

@Eonfge Eonfge closed this as completed Oct 17, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
build related Tags for build related issues, discussions and requests
Projects
None yet
Development

No branches or pull requests

6 participants