Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adding installation and running information #7

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Adding installation and running information #7

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 14 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,2 +1,15 @@
# elixir-mpd-client
MPD client made with Elixir
*WIP* MPD client made with Elixir

For the application to work, it is currently required to have `mpd` installed and running as a daemon on the default port (`6600`).

# Installation
1. Clone the repo;
2. Go into the repo directory and issue `mix deps.get`;
3. Issue `iex -S mix phx.server`;
4. Play around with some of the currently implemented commands:
- `ElixirMpdServer.MpdServer.next()`;
- `ElixirMpdServer.MpdServer.previous()`;
- `ElixirMpdServer.MpdServer.playlist_info()`;
- `ElixirMpdServer.MpdServer.status()`.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please add info about installing assets with npm.
Add info about running watch.
Add info about adding songs in playlist for mpd.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We are unable to add songs through the library ATM, but I will add info about the rest of the points.