From 575fdc638625ab184b7d57f4e2f35d317745233d Mon Sep 17 00:00:00 2001 From: 0d0 <0d0acre@esiliati.org> Date: Tue, 25 Feb 2025 01:14:53 +0100 Subject: [PATCH] Update readme --- README.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 817d044..5fbea89 100644 --- a/README.md +++ b/README.md @@ -5,13 +5,13 @@ screen -It's a svelte(kit) frontend that uses `yt-dlp` to let the user download things from the web. +It's a svelte(kit) frontend + backend that uses [`yt-dlp`](https://github.com/yt-dlp/yt-dlp) to let the user download audio/video files from the web. ## How to Deploy -### using node +### Node -- Install nodejs (if on debian, use `extrepo` for adding the official nodesource repository) +- Install NodeJS - Create a new directory (`"${PROJECT_ROOT}"`) - run `scripts/install.sh "${PROJECT_ROOT}"` @@ -23,8 +23,8 @@ Edit `scripts/deploy_example.sh` if you need to deploy `scaricatore` to some ser ## Development: getting started -- Clone the repo -- Run `npm install` (you have to have node installed) +- run `git clone git@git.pweapon.org:odo/dl.emersa.it.git` +- Run `cd dl.emersa.it; npm install` (you have to have node installed) - Run `npm run download-yt-dlp` - Copy `.env.example` to `.env` - Change `.env` to set `YTDLP_PATH` to the yt-dlp binary previously downloaded @@ -33,7 +33,7 @@ Edit `scripts/deploy_example.sh` if you need to deploy `scaricatore` to some ser ## To do: -- Proper logs (I don't like them, not useful for production build) +- Logs (I don't like them, not useful for production build but somewhere sometime they are needed) - Containerfile for container build - Source spotify (spotdl) - Parse URL info without `youtube-dl-exec`