Skip to content

Commit

Permalink
Update REadm
Browse files Browse the repository at this point in the history
  • Loading branch information
fenimore committed Feb 10, 2018
1 parent c707840 commit f352325
Showing 1 changed file with 24 additions and 6 deletions.
30 changes: 24 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,17 +5,15 @@ and adds any directory with audio files to the music library. From there you can
play your music from the comfort of the commandline, with familiar **emacs** style
keybindings. If you don't store your music locally, this isn't the right player for you :).

Alio is written in go but relies on C bindings for the `libvlc` library. Check out the releases tap to get the latest executable (currently only compiled for Linux).
Alio is written in go but relies on C bindings for the `libvlc` library. Check out the releases tap to get the latest executable _dependency free_ (currently only compiled for Linux).

![Alio](/screenshot.png?raw=true)

## Flags

- -h for help
- -debug: bool, log messages in debug.log
- -dir str, music collection directory (default "Music")
- -nocolor bool, don't use color highlighting

- `-h ` for help
- `-dir ` music collection directory (default "Music")
- `-nocolor ` remove color highlighting

## Keybindings (Emacs with some Vim bonuses)

Expand All @@ -42,6 +40,26 @@ Alio depends on `libvlc 2.X` for _build_, but the **releases** are dependency fr
- [libvlc-go](https://github.com/adrg/libvlc-go) - MIT
- [tui-go](https://github.com/marcusolsson/tui-go/) - MIT

## License

```
Alio commandline musice player
Copyright (C) 2017 - 2018 Fenimore Love
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
```

## UI todos

- [ ] Scrollable song list
Expand Down

0 comments on commit f352325

Please sign in to comment.