From f6b4ea4a468b087a0e11a864a7d725cfc1d1585e Mon Sep 17 00:00:00 2001 From: Philipp Wolfer Date: Fri, 24 Nov 2023 08:30:32 +0100 Subject: [PATCH] README: Some preliminary installation instructions --- README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/README.md b/README.md index 9070fa1..862d388 100644 --- a/README.md +++ b/README.md @@ -13,6 +13,17 @@ Scotty transfers your listens/scrobbles and favorite tracks between various musi - Store your favorite tracks from Deezer as a JSPF playlist +## Installation + +Scotty is a command line utility written in Go. Currently the easiest way to get Scotty is by installing it from source with the following command: + + go install go.uploadedlobster.com/scotty@latest + +This requires `go` to be installed on your systems. You can get it from https://go.dev/dl/ . + +In the future pre-built binary releases of Scotty will also be made available. + + ## Configuration Scotty requires the configuration of the services in a configuration file in TOML format. See [scotty.example.toml](./scotty.example.toml) for details.