Skip to content

Commit

Permalink
add icon and update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
MarckTomack committed Jul 5, 2020
1 parent 315a9bd commit fe1476a
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 27 deletions.
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
/.vscode
build.sh
build.sh
pkg.dbp
41 changes: 15 additions & 26 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,31 +1,33 @@
# aloneMP

A minimal music player terminal based.
(Insipred by <a href="https://github.com/Depado/parakeet">parakeet</a>)

aloneMP is composed of two elements, the daemon (aloneMPd) and the clients, for now is avaiable only the terminal client with a TUI

<img src="demo.gif" alt="demo">

# Download and installation on Linux
# Download and installation on Debian and friends

Download <a href="https://github.com/marcktomack/aloneMP/releases">here</a>
You need to have systemd.

Extract the zip
Download the .deb package <a href="https://github.com/marcktomack/aloneMP/releases">here</a>

```
cd aloneMP
chmod +x install.sh
sudo ./install.sh
```
This enable the daemon and install aloneMP

There are also the zip with only the binary if you want to configure all the things manually

I will provide more packages and installation types.

# Usage

```
Usage of aloneMP:
Usage of ./aloneMP:
-addr string
http server address (default "127.0.0.1:3777")
aloneMP daemon address (default "127.0.0.1:3777")
-dir string
Directory with audio files (default "~/Music")
-s Run the http server
-tui
run tui client (default true)
```

Expand All @@ -35,23 +37,10 @@ You can pass a directory with audio files:

Or by default it will load audio files from `~/Music`

You can also run the http server with -s and pass the address with -addr (default is 127.0.0.1:3777)
You need to provide the daemon http server address the default one is 127.0.0.1:3777, same on the daemon

Docs for http server and http server it self is under construction

Supported formats are <b>MP3</b>, <b>FLAC</b>, <b>OGG</b> and <b>WAV</b>

# Build from source

You need a <a href="https://golang.org/dl/">Go compiler</a>

```
git clone https://github.com/MarckTomack/aloneMP
cd aloneMP
go build
```

# Depndencies

aloneMP uses <a href="https://github.com/faiface/beep">beep</a> that uses <a href="https://github.com/hajimehoshi/oto">oto</a> see the dependencies <a href="https://github.com/hajimehoshi/oto#prerequisite">here</a>

Binary file added aloneMP-icon.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit fe1476a

Please sign in to comment.