search

MrS0m30n3 / youtube-dl-gui

A cross platform front-end GUI of the popular youtube-dl written in wxPython.
The Unlicense
9.27k stars 1.58k forks source link

add a manpage #259

Closed legrostdg closed 6 years ago

legrostdg commented 6 years ago

It would help Debian packaging to add a simple manpage.

MrS0m30n3 commented 6 years ago

In my opinion there is no point in adding a manpage, since there are no command-line args and adding just the NAME, SYNOPSIS, etc sections is just a waste of time.

nodiscc commented 6 years ago

I proposed a very simple manpage in https://github.com/MrS0m30n3/youtube-dl-gui/pull/261, it's not much but it clarifies the basics, I also think Debian requires manpages for each binary, and it's nice to be able to list available programs by typing man y<TAB><TAB>. I had never written a manpage in the past so here it is.

@legrostdg you may also want to add a packaging rule to copy README.md, CHANGELOG and TODO (?) to /usr/share/doc/. I've seen many packages do that and it's nice to have all the docs available locally.

MrS0m30n3 commented 6 years ago

Added a simple manpage +other-stuff, based on the @nodiscc's pull-request. The setup installs the manpage in {prefix}/share/man/man1/ automatically, so you don't have to modify anything on the debian packaging side (probably).

legrostdg commented 6 years ago

@MrS0m30n3 do you think you could push another release? It would help getting this in Debian.

MrS0m30n3 commented 6 years ago

Nope, i want to take care of all the issues in Release 0.4.1 - Milestone first.

legrostdg commented 6 years ago

OK, I'll wait for this new release before integrating the changes in the Debian package.