From 9d81bd146862010fa9fa5e1a50bc79f2c0a0237b Mon Sep 17 00:00:00 2001 From: FatKiwi Date: Tue, 12 Mar 2019 12:51:07 +0000 Subject: [PATCH] Update README.md Moved guides to Wiki --- README.md | 128 ++---------------------------------------------------- 1 file changed, 3 insertions(+), 125 deletions(-) diff --git a/README.md b/README.md index e4b5b1e..3703429 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,6 @@ It is intended for educational and private use only, and not as a tool for pirat Remember that the artists and studios put a lot of work into making music - purchase music to support them. - ## Features - Download music in excellent quality for free @@ -24,14 +23,6 @@ Remember that the artists and studios put a lot of work into making music - purc - CLI support - -## Supported sites - -- Currently only Deezer is supported. -- We'll add more in the future ;) - - - ## Supported platforms - Windows x64 @@ -44,123 +35,11 @@ Remember that the artists and studios put a lot of work into making music - purc ## How to login with arl cookie -Please check the guide on the [Wiki](https://git.fuwafuwa.moe/SMLoadrDev/SMLoadr/wiki/How-to-login-via-cookie) - -## How to use (Windows) - -Run it as admin if you get "EPERM: operation not permitted..." error! - -###Interactive: -``` -Double click the exe :) -``` - -###CLI: -``` -.\SMLoadr-win-x64.exe -q "MP3_128" -p "DOWNLOADS/" "http://www.deezer.com/album|artist|playlist|profile|track/0123456789" -``` - - - -## How to use (Linux/MacOS) - -See "How to use (from source)" to run it on ARM devices like the Raspberry Pi. - -###Interactive: -``` -chmod +x SMLoadr-linux-x64 -./SMLoadr-linux-x64 -``` - -###CLI: -``` -chmod +x SMLoadr-linux-x64 -./SMLoadr-linux-x64 -q "MP3_128" -p "DOWNLOADS/" "http://www.deezer.com/album|artist|playlist|profile|track/0123456789" -``` - - -## How to use (Android): _Automatic Method_ - - -If you run into errors please tag @NeonDragon1909 in Telegram - -### 1. Install Termux -In order to run SMLoadr on Android you have to install `Termux`. -- Play Store: [link](https://play.google.com/store/apps/details?id=com.termux) -- Apk Mirror: [link](https://www.apkmirror.com/apk/fredrik-fornwall/termux) - -### 2. Install dependencies -Run `Termux` and enter these lines in the given order (If it asks you if you want to continue, enter `y`): -``` -pkg update -pkg upgrade -pkg install curl -``` - -### 3. Downlaod the install script -After installing all the needed dependencies download the install script make it executable and start it. -Follow the instructions on Screen. -``` -curl https://del.dog/raw/helpme > SMLoadr.sh -chmod +x SMLoadr.sh -./SMLoadr.sh -``` - -### 4. CLI parameters for the Automatic Version (optional) -If you want to change the Folder where SMLoadr saves the music on Android enter the following line and enter the full path to where you want to have the music saved. -``` -./SMLoadr.sh -c -``` - -To pass the regular CLI parameters from SMLoadr onto the Script version use the `-o` argument and enter you parameters in between `'` -eg.: -``` -./SMLoadr.sh -o '-q MP3_128 -d single DeezerURL' -``` - -### 5. Start SMLoadr from Termux -Whenever you want to start SMLoadr on your Phone just enter ```./SMLoadr.sh``` into Termux and you are ready to go. - -## How to run (from source) - -To run it from source you have to install [Node.js](https://nodejs.org/) first (>= 8.0.0 is required). -Node.js 9 is recommended, while Node.js 10 is currently not working well with the code, but changes will be made in future. - -After that download/clone the repo and execute the following commands in the directory: -``` -# Install dependencies -npm install - -# Run the app -node SMLoadr.js -``` - -## How to compile to executable - -Windows: - -``` -# Install dependencies -npm install - -# Run the build script -BUILD.cmd -``` - -Linux: - -``` -# Install dependencies -npm install - -# Run the build script -./BUILD.sh linux - -# Run './BUILD.sh -h' for help -``` - +Guide on the [Wiki](https://git.fuwafuwa.moe/SMLoadrDev/SMLoadr/wiki/How-to-login-via-cookie) +## How to use, run and compile +Guide on the [Wiki](https://git.fuwafuwa.moe/SMLoadrDev/SMLoadr/wiki/How-to-use%2C-run-and-compile) ## CLI parameters @@ -201,6 +80,5 @@ npm install - We do **not** give any guarantee at all and we are **not** responsible for damages of all kinds! - --- > Made with :heart: & :beer: by SMLoadrDevs | Copyright © 2018 SMLoadrDevs. \ No newline at end of file