Appstream file and manual page

jahnf / Projecteur

Linux Desktop Application for the Logitech Spotlight device (and similar devices) - Digital Laser Pointer

MIT License

379 stars 33 forks source link

Appstream file and manual page #95

Closed llimeht closed 4 years ago

llimeht commented 4 years ago

This is a draft PR looking to add an appstream metainfo file and manual page to to Projecteur.

Both these files should probably live in cmake/templates/ instead and have some level of templating done to them. They also need to be actually installed by CMake.

I'm happy to figure out more about Projecteur's CMake set up to look more at this at some stage, but also very happy for anyone else to do so!

jahnf commented 4 years ago

Hi Stuart, thank you for your pull request.

Where should these files be installed to?

I would then merge your pull request and integrate it as a template for CMake if that's okay for you.

llimeht commented 4 years ago

The normal places for these are:

/usr/share/man/man1/projecteur.1.gz /usr/share/metainfo/projecteur.metainfo.xml

(or /usr/share/metainfo/com.github.jahnf.projecteur.metainfo.xml to follow the domain-based naming, but then other things should change to to match that)

I assume that there are CMake macros for installing these files that would find the right place when there's an installation prefix like ~/, /opt, /usr/local etc.

jahnf commented 4 years ago

Alright good to know, the places (or rather the file names you suggested) are fine with me. And yes CMake has a way to deal with the install prefix; See: https://cmake.org/cmake/help/v3.8/variable/CMAKE_INSTALL_PREFIX.html (CMAKE_INSTALL_PREFIX and DESTDIR)

Is the manual always installed zipped (.gz)?
Could you move to the files to the cmake/template directory within your pull request?
- I would then integrate it (template variables + installation)

llimeht commented 4 years ago

Force pushed to be based off develop not master (I missed that earlier, sorry) and also to relocate the two files.

The FHS doesn't say anything about compressing man pages; Debian Policy says that they should be compressed and all of them are.

jahnf commented 4 years ago

Perfect, thank you for the details. I have one other question: Are the categories in the metainfo file the same as you would find them in .desktop files?

llimeht commented 4 years ago

Yes, the categories are the same: https://www.freedesktop.org/software/appstream/docs/chap-Metadata.html#tag-categories

jahnf commented 4 years ago

I changed the pull request target branch to tmp/doc, so that I can finish the CMake integration before then finally merging to develop.

jahnf commented 4 years ago

@llimeht Will notify you when installation and templates are ready and in develop (Hopefully within the next few days).