Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
Update README.md
  • Loading branch information
Aveek-Saha committed Nov 30, 2018
1 parent 632c922 commit dcfb59e
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion README.md
Expand Up @@ -15,9 +15,11 @@ A minimalistic music player, designed for simplicity. Built on electron, uses Ho

This can also serve as a starting point to impliment your own front-end/UI to the Player.

Download here: [Releases](https://github.com/Aveek-Saha/MusicPlayer/releases)

# How to use
### 1. The Player
Start the application and and then click on the Folders tab on the top left corner, this will bring up a window where you can select the folder where you want to play your mp3 files from.
Download the build for your OS. Start the application and and then click on the Folders tab on the top left corner, this will bring up a window where you can select the folder where you want to play your mp3 files from.
Once you select a folder with songs, just click play.
### 2. Building from the repo
Clone the repository, then navigate to it on your terminal and run ```npm install```, once all the dependencies have finished downloading, run ```npm start ``` to test it, and ```npm run dist ``` to build it for your platform.
Expand Down

0 comments on commit dcfb59e

Please sign in to comment.