Skip to content

Commit

Permalink
Add a simple README
Browse files Browse the repository at this point in the history
mpasa committed Nov 21, 2018
1 parent fe9df7c commit 4da0c23
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# Readme
A small project written in Scala to fetch and display the lyrics of the current playing song on the command line. The lyrics will be updated when a new song is played.


## Dependencies
It assumes that you system has 2 installed tools:

- `playerctl` to fetch the playing song information.
- `less` to display the results.


## Running
1. `java -jar sclyrics.jar`


## Running from source
1. `sbt assembly`
2. `java -jar target/scala-2.12/sclyrics.jar`

0 comments on commit 4da0c23

Please sign in to comment.