From 71160047d8207677972e9f6c9f26750286c67a71 Mon Sep 17 00:00:00 2001 From: fiso64 Date: Tue, 27 Aug 2024 00:40:38 +0200 Subject: [PATCH] commit --- README.md | 45 ++++++++++++++++++++++---------------------- slsk-batchdl/Help.cs | 15 +++++++-------- 2 files changed, 29 insertions(+), 31 deletions(-) diff --git a/README.md b/README.md index e102d8a..635ef08 100644 --- a/README.md +++ b/README.md @@ -3,26 +3,25 @@ A batch downloader for Soulseek built with Soulseek.NET. Accepts CSV files and Spotify or YouTube urls. ## Index -- [slsk-batchdl](#slsk-batchdl) - - [Options](#options) - - [Input types](#input-types) - - [CSV file](#csv-file) - - [YouTube](#youtube) - - [Spotify](#spotify) - - [Bandcamp](#bandcamp) - - [Search string](#search-string) - - [Download modes](#download-modes) - - [Normal](#normal) - - [Album](#album) - - [Aggregate](#aggregate) - - [Album Aggregate](#album-aggregate) - - [Searching](#searching) - - [File conditions](#file-conditions) - - [Name format](#name-format) - - [Skip existing](#skip-existing) - - [Configuration](#configuration) - - [Examples](#examples-1) - - [Notes](#notes) + - [Options](#options) + - [Input types](#input-types) + - [CSV file](#csv-file) + - [YouTube](#youtube) + - [Spotify](#spotify) + - [Bandcamp](#bandcamp) + - [Search string](#search-string) + - [Download modes](#download-modes) + - [Normal](#normal) + - [Album](#album) + - [Aggregate](#aggregate) + - [Album Aggregate](#album-aggregate) + - [Searching](#searching) + - [File conditions](#file-conditions) + - [Name format](#name-format) + - [Skip existing](#skip-existing) + - [Configuration](#configuration) + - [Examples](#examples-1) + - [Notes](#notes) ## Options @@ -89,7 +88,7 @@ Usage: sldl [OPTIONS] ``` Searching --fast-search Begin downloading as soon as a file satisfying the preferred - conditions is found. Higher chance to download wrong files. + conditions is found. Only for normal download mode. --remove-ft Remove 'feat.' and everything after before searching --no-remove-special-chars Do not remove special characters before searching --remove-brackets Remove square brackets and their contents before searching @@ -283,12 +282,12 @@ Input String | Artist | Title | Album | Lengt The program will download a single file for every input entry. ### Album - The program will search for the album and download an entire folder including non-audio + sldl will search for the album and download an entire folder including non-audio files. Activated when the input is a link to a spotify or bandcamp album, when the input string or csv row has no track title, or when -a/--album is enabled. ### Aggregate - With -g/--aggregate, the program will first perform an ordinary search for the input, then + With -g/--aggregate, sldl will first perform an ordinary search for the input, then attempt to group the results into distinct songs and download one of each kind. A common use case is finding all remixes of a song or printing all songs by an artist that are not your music dir. diff --git a/slsk-batchdl/Help.cs b/slsk-batchdl/Help.cs index dafa1d7..e3609bf 100644 --- a/slsk-batchdl/Help.cs +++ b/slsk-batchdl/Help.cs @@ -67,7 +67,7 @@ public static class Help Searching --fast-search Begin downloading as soon as a file satisfying the preferred - conditions is found. Higher chance to download wrong files. + conditions is found. Only for normal download mode. --remove-ft Remove 'feat.' and everything after before searching --no-remove-special-chars Do not remove special characters before searching --remove-brackets Remove square brackets and their contents before searching @@ -253,15 +253,14 @@ public static class Help The program will download a single file for every input entry. Album - The program will search for the album and download an entire folder including non-audio - files. Activated when the input is a link to a spotify or bandcamp album, when the input - string or csv row has no track title, or when -a/--album is enabled. + sldl will search for the album and download an entire folder including non-audio files. + Activated when the input is a link to a spotify or bandcamp album, when the input string + or csv row has no track title, or when -a/--album is enabled. Aggregate - With -g/--aggregate, the program will first perform an ordinary search for the input, then - attempt to group the results into distinct songs and download one of each kind. A common use - case is finding all remixes of a song or printing all songs by an artist that are not your - music dir. + With -g/--aggregate, sldl will first perform an ordinary search for the input, then attempt to + group the results into distinct songs and download one of each kind. A common use case is + finding all remixes of a song or printing all songs by an artist that are not your music dir. Two files are considered equal if their inferred track title and artist name are equal (ignoring case and some special characters), and their lengths are within --length-tol of each other.