aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md5
1 files changed, 4 insertions, 1 deletions
diff --git a/README.md b/README.md
index d0c2f1e..a3b0ca9 100644
--- a/README.md
+++ b/README.md
@@ -6,7 +6,7 @@ YouToo takes a YouTube playlist ID, and:
* syncs; and
* adds metadata
-to the files.
+to songs.
## Requirements
* NodeJS 14 or later
@@ -17,6 +17,8 @@ to the files.
## Usage
First, go to the folder where you downloaded the source code (the folder where the "index.js" file is located). Also make sure `node`, `ffmpeg`, `yt-dlp` and `magick` are in your `PATH`
+> Running `npm install` shouldn't be required, but if you encounter issues you may need to run it.
+
On Windows (PowerShell):
```
node .\index.js <your YouTube playlist ID>
@@ -57,5 +59,6 @@ If you have issues running YouToo, follow these steps:
2. **update NodeJS.** We recommend using the latest stable release, or the latest long term support release. YouToo has been tested on NodeJS 17.3.0.
3. **free up disk space.** Required disk space depends on the size of your playlist. To be safe, make sure you have 16MB per song.
4. **delete the `./_youtoo` folder.** This will completely reset YouToo, so in case a cache file is corrupted, it will all be reset. You may backup the `./_youtoo/Result` folder if you don't want to have to download all the songs again.
+5. **run `npm install`.** This will update all dependencies and perhaps solve the issue.
If these steps didn't help you, open an issue to this project. We will be more than happy to help! \ No newline at end of file