parent
2c23c1c7aa
commit
cbaa488962
29
README.md
29
README.md
|
@ -1,17 +1,36 @@
|
|||
# youtube-cue
|
||||
|
||||
Helps you tag music compilations from youtube by generating a Cue sheet. Use alongside [cuetag.sh](https://command-not-found.com/cuetag.sh), [m4acut](https://github.com/nu774/m4acut), or [mp3splt](https://sourceforge.net/p/mp3splt/) or any other Cue sheet tooling.
|
||||
Generate CUE sheet from timestamps in youtube video description.
|
||||
|
||||
## Dependencies
|
||||
## What is this for?
|
||||
|
||||
1. If you have DJ-mix or album on YouTube that you'd like to generate a [CUE sheet][cue] for.
|
||||
2. The video has timestamps in the video description.
|
||||
3. The video is publicly available on Youtube.
|
||||
|
||||
`youtube-cue` will read the video description, get the timestamps and generate a [CUE sheet][cue] accordingly.
|
||||
|
||||
## Anti-features
|
||||
|
||||
1. It does not download tracks from YouTube
|
||||
2. It does not split your tracks
|
||||
3. It does not tag your tracks.
|
||||
|
||||
For all of the above, there are better tools available, such as [youtube-dl](https://ytdl-org.github.io/youtube-dl/), [m4acut](https://github.com/nu774/m4acut), [mp3splt](https://sourceforge.net/projects/mp3splt/), [cuetools](https://github.com/svend/cuetools), [beets](https://beets.io) and many more. youtube-cue tries to [do one thing well](https://onethingwell.org/).
|
||||
|
||||
- None
|
||||
|
||||
## Installation
|
||||
|
||||
npm install -g youtube-cue
|
||||
|
||||
## Upgrade
|
||||
|
||||
npm update -g youtube-cue
|
||||
|
||||
## Usage
|
||||
|
||||
You need to pass 2 parameters, a Youtube URL and a output CUE filename. YouTube short URLs (`youtu.be`) are accepted. You can additionally pass a `audio-file` argument which is used for the [`FILE` specified in the CUE file][cuefile].
|
||||
|
||||
Generates Cue sheet from Youtube URL
|
||||
|
||||
Usage
|
||||
|
@ -44,7 +63,7 @@ function ytdl.album() {
|
|||
|
||||
## HACKING
|
||||
|
||||
- If this video does not work on a specific video, please attach the debug log output
|
||||
- If this video does not work on a specific video, please attach the complete output
|
||||
- Pull Requests are welcome that add support for a better parser without breaking the existing tests
|
||||
- Please add tests for any new functionality
|
||||
|
||||
|
@ -54,3 +73,5 @@ Licensed under the [MIT License][mit]
|
|||
|
||||
[mit]: https://nemo.mit-license.org/
|
||||
[rdd]: http://tom.preston-werner.com/2010/08/23/readme-driven-development.html
|
||||
[cue]: https://en.wikipedia.org/wiki/Cue_sheet_(computing)
|
||||
[cuefile]: https://en.wikipedia.org/wiki/Cue_sheet_(computing)#Essential_commands
|
||||
|
|
Loading…
Reference in New Issue