Skip to content
This repository has been archived by the owner on Aug 23, 2024. It is now read-only.

Commit

Permalink
Updated readme with release's generation procedure
Browse files Browse the repository at this point in the history
  • Loading branch information
CoffeeStraw committed Mar 24, 2021
1 parent 2eb275f commit 0ed494a
Showing 1 changed file with 11 additions and 13 deletions.
24 changes: 11 additions & 13 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,25 +17,23 @@ Scaricate [l'ultima release](https://github.com/CoffeeStraw/VVVVID-Downloader/re
### Docker
Per installare ed utilizzare il software tramite **Docker**, basterà lanciare il file ```vvvvvid-downloader.sh```. Esso si occuperà di lanciare il container e monterà la cartella dei *Downloads* come volume esterno.

### Per Developer
Ovviamente la prima cosa da fare è scaricare il progetto, usando `git clone` oppure scaricandone lo zip e poi estraendolo dove più vi è comodo. Dopodiché:

1. Lo script richiede Python3, [scaricabile qui](https://www.python.org/downloads/). **Nota per gli utenti Windows**: è necessario che durante l'installazione sia aggiunto Python3 al PATH. Una possibile guida per l'installazione è consultabile [qui](https://realpython.com/installing-python/).
2. Vanno installate le librerie esterne. Per farlo, recatevi nella cartella del progetto ed utilizzate pip (oppure pip3 nel caso non vada) per installarle:
```sh
pip install -r requirements.txt
```
3. A questo punto basterà avviare il programma:
```sh
python main.py
```

## 🎮 Utilizzo
Per poter utilizzare VVVVID Downloader, tutto quello che dovrete fare è porre il link a ciò che desiderate scaricare da VVVVID all'interno del file **downloads_list.txt**, che contiene già degli esempi.
## ℹ️ Note:
- Se avete più link, vanno posizionati ognuno su una linea a parte.
- Le linee che cominciano con **#** saranno ignorate, può tornare utile se volete ignorare temporaneamente qualcosa ad esempio.
- Per motivi di copyright VVVVID non è disponibile all'estero, per cui è necessario possedere un indirizzo IP italiano.

## 👨‍💻 Developers - Release Windows
Per creare l'eseguibile Windows viene utilizzato **pyinstaller**. Una volta installato con **pip**, i passaggi sono i seguenti:
- Posizionarsi nella cartella ```src/``` del progetto;
- Creare una cartella ```ffmpeg/``` contenente l'ultima release di ffmpeg;
- Produrre l'eseguibile col comando:
```sh
pyinstaller -F --add-data "./ffmpeg/bin/*;./ffmpeg/bin/" --add-data "./ffmpeg/presets/*;./ffmpeg/presets/" main.py
```
- Affiancare all'eseguibile i files ```downloads_list.txt``` e ```VVVVID Downloader.bat```, che potete trovare nelle release vecchie;
- Spostare l'eseguibile in una nuova cartella denominata ```bin/```.

## 🧭 Licenza
Il presente software è distribuito sotto licenza MIT. Si legga il file `LICENSE` per ulteriori informazioni.

0 comments on commit 0ed494a

Please sign in to comment.