search

Cuperino / QPrompt-Teleprompter

Teleprompter software for all video creators. Built with ease of use, productivity, control accuracy, and smooth performance in mind.
https://qprompt.app
GNU General Public License v3.0
379 stars 26 forks source link

Written documentation #27

Open sunset71 opened 2 years ago

sunset71 commented 2 years ago

Edit by @Cuperino

Due to limited time, it may be a while before I get around to properly writing QPrompt's documentation.

Imaginary Teleprompter (the project that preceded QPrompt) didn't have any documentation for a long time because writing good documentation takes a while and we had trouble allocating enough time for it. I finally got around to writing it in the middle of a nation-wide blackout that lasted for several months. I had some free time in my hands, and it didn't consume much of my laptop's battery.

If you have some free time on your hands, please consider writing documentation for QPrompt.

Original post

Bug Description

Link to website not working, no access to supporting documents

Cuperino commented 2 years ago

Hello @sunset71

QPrompt is a new project. I'm actually setting up the server that will hold the website right now as we speak.

With regards to documentation, it hasn't been created yet. Please join our Telegram chat or the forum that I'm about to create if you'd like to join the discussion to help create supporting documents.

Cuperino commented 2 years ago

@sunset71, What kind of supporting documents would you be interested in?

Right now I have queued:

sunset71 commented 2 years ago

In addition to the two items above, I have a software suggestion--which may or may not be possible to do. I would like to be able to have my video recording application--such as some or Logitech's capture--start recording just as your software begins to pay the script.

Cuperino commented 2 years ago

Well that goes outside the topic of documentation, so please open a new request to help keep the project organized. But, with regards to your suggestion, yes! I have plans for things like that:

  1. There's already a trigger mechanism in place that people will be able to use to trigger commands in other programs over the network using HTTP requests. Once fully implemented, this could be used with OBS to record from webcams and to automatically switch between multiple cameras.

  2. For mobile and PC users, I also plan to provide the ability to record videos straight from QPrompt. This would be particularly geared to those recording from their cellphones.

  3. I'm also planning to adding support for the MOS protocol, which allows for interactions with newsroom equipment. Users would provide updated contents over the network and trigger the teleprompter's start automatically.

  4. Finally I'm considering adding Pipewire support, which could be used to synchronize time codes between QPrompt and other audio and video recording software under Linux. This addition is more unlikely since it is still early days for Pipewire, and there is more need and demand for the features I previously mentioned.

Cuperino commented 2 years ago

Due to limited amount of time, it may be a while before I get around to properly writing QPrompt's documentation.

Imaginary Teleprompter didn't have any documentation for a long time because writing good documentation takes time and we had trouble allocating enough free time for it. I finally got around to writing it in the middle of a nation-wide blackout that lasted several months; because I had some free time in my hands, and it didn't consume much of my laptop's battery.

If you have free time on your hands, please consider writing documentation for this project.