search

Breakthrough / PySceneDetect

:movie_camera: Python and OpenCV-based scene cut/transition detection program & library.
https://www.scenedetect.com/
BSD 3-Clause "New" or "Revised" License
3.25k stars 395 forks source link

Add Man-Page for Unix-Like Systems #9

Open Breakthrough opened 8 years ago

Breakthrough commented 8 years ago

As per title, add a man-page synopsis so users can call man scenedetect for detailed usage help.

In PySceneDetect v0.5-beta-1, help text / a complete CLI reference can be obtained via scenedetect help all or from this page.

Perhaps use Pandoc to convert a designated Markdown file during package creation: http://www.pandoc.org/demos.html

Or calling PySceneDetect itself to generate the manpage file via the help all command piped to a text file?

Not sure what the best solution is, but ideally, it would re-use as much information/resources already available as possible, and be automated to make continuous integration and future releases much smoother.

ghost commented 6 years ago

Hi,

I am trying to write the man page(If i may).

I have a few questions, which are as follows:

  1. Should the man page be a separate file? If yes, maintaining multiple documents (manpage.md, readme.md and usage.md) with some common information would be tedious.

  2. Can the information required to form manpage.md be extracted from existing documents/code?

This is my first effort to make an OSS contribution. I am not sure if this is a good first issue to pick up. Please guide.

Breakthrough commented 6 years ago

Absolutely, feel free! (Make sure to include all the CLI parameters if you do so, can also get it from v0.5-beta-1 by calling help all). There is just one last feature (the -n flag on the save-images command) and documentation that is being updated before the release of v0.5, so some of the documentation may be expanded.

In response to your questions:

  1. No if possible, but I'm not sure if that is... One option is to call scenedetect help all and use that as the man scenedetect text, which I am more than open to. If this needs to be saved as an actual manpage file and updated as part of the release process, that's okay with me so long as it can be automated.

  2. Absolutely, yes! Also again, not sure if it needs to be a .md file - all I know is I want to be able to run man scenedetect on Linux in order to close this issue 😄

The hardest part of the issue would be distributing it in a way that lets you do man scenedetect on a Linux system. I'm not sure how to do that, or if it's even possible (may require writing a shell script to be executed afterwards in the setup.py?)...

That being said, please feel free to take on the issue if you think you can complete it - have confidence, and thank you for your interest in PySceneDetect! 🎥