Skip to content

Commit

Permalink
Add "Installation" section to README
Browse files Browse the repository at this point in the history
  • Loading branch information
Ezwen committed Dec 6, 2020
1 parent fc2342d commit 2f21158
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions README.adoc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,13 @@ This will download all albums ever bought by the Bandcamp account _myBandcampIde

After downloading the first album, it will create a `bandcamp-collection-downloader.cache` file in the chosen download folder. This allows the tool to remembers which albums have already been successfully downloaded, and thus prevents unnecessarily hitting the Bandcamp servers.

=== Installation

Releases are published on link:https://framagit.org/Ezwen/bandcamp-collection-downloader/-/releases[this page].

Each release comes with an executable jar file that contains all required dependencies, and that can therefore be directly executed with a simple `java -jar` command.
Look for the link named _Executable jar_ under each release description.

=== Compiling

The tool is written in Kotlin and compilation is handled by Gradle. A Gradle task named `fatJar` is available to build a standalone executable jar with all dependencies:
Expand Down

0 comments on commit 2f21158

Please sign in to comment.