Coder Social home page Coder Social logo

Comments (2)

 avatar commented on July 2, 2024

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.

from pyscenedetect.

Breakthrough avatar Breakthrough commented on July 2, 2024

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! 🎥

from pyscenedetect.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.