Skip to content

Update README.md #19

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
le-jun wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update README.md #19

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 8 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,22 @@ Youtube-to-Webpage is a Perl script to create a webpage from a Youtube video wit

The project is built upon:

* [Perl](https://www.perl.org/) (duh)
* [yt-dlp](https://github.com/yt-dlp/yt-dlp)
* [ffmpeg](https://ffmpeg.org/)

**Check you have those installed, and they're updated (especially yt-dlp thanks to Youtube's API changes).**

If you don't have any Perl interpreter, feel free to check the portable version of [Strawberry Perl](https://strawberryperl.com/) as recommended on the [official Perl's download page](https://www.perl.org/get.html).

## Using

To use, run the Perl script with a name for the folder to create, and the video URL. For example:
No installation needed. To use, run the Perl script with a name for the folder to create, and the video URL. For example:

```./yt-to-webpage.pl project-name "https://www.youtube.com/watch?v=jNQXAC9IVRw"```

**As of now, the script seems to only work under UNIX environments. We'd be happy to receive help for a port to Windows.**

## Output

Running the script create a repository according to the following structure:
Expand Down