diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 37 |
1 files changed, 37 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..f70fc6f --- /dev/null +++ b/README.md @@ -0,0 +1,37 @@ +# Simple Hypervideo Downloader GUI + +Simple Hypervideo Downloader GUI is intended +to serve as a basic interface for downloading YouTube videos/audio +that can be easily shared and used by non-programmers. + + + +### Usage +1. Run `python hypervideo_gui.py` +1. Enter the URL of the video you want to download into the top "URL" textbox. +1. Then enter the folder to save the video to in the "Output Folder" textbox. +1. Next choose the video format + 1. To download the highest quality of video, select the video format `Video - Best Quality` + 1. If you only want the audio (saved as .mp3), select `Audio Only - Best Quality` + 1. If you want another video format, click `Detect All Available Formats`, which will + fetch the available video formats and populate the dropdown with the available formats. + Warning: some of these formats may be video only or audio only! +1. Click the Download button. + +### Config directory downloads + +For default, download path settings are saved in file +`~/.config/hypervideo_gui/hypervideo_gui_state.json` + +### Developer Setup +Just set up Python3 with libraries PyQT5 (`pacman -S python-pyqt5`), +hypervideo (`pacman -S hypervideo`), +and ffmpeg (`pacman -S ffmpeg`) and run hypervideo_gui.py +(cd to the repository path, and then `python hypervideo_gui.py`). + +### Troubleshooting +Make sure you have the latest version of hypervideo! Use `pacman -Sy hypervideo`in the command line. +For downloading audio only, you may need to install ffmpeg to handle the mp4 -> mp3 conversion + +## License +This work is under the License [GNU GPLv3+](LICENSE) |