README: Some preliminary installation instructions

This commit is contained in:
Philipp Wolfer 2023-11-24 08:30:32 +01:00
parent 3ce0851f45
commit f6b4ea4a46
No known key found for this signature in database
GPG key ID: 8FDF744D4919943B

View file

@ -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 - 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 ## Configuration
Scotty requires the configuration of the services in a configuration file in TOML format. See [scotty.example.toml](./scotty.example.toml) for details. Scotty requires the configuration of the services in a configuration file in TOML format. See [scotty.example.toml](./scotty.example.toml) for details.