From fa1bcb1f70e81fa7c10376a6785cf15d8d6ebb14 Mon Sep 17 00:00:00 2001 From: raziman Date: Tue, 23 Jun 2020 19:27:59 +0800 Subject: [PATCH] update readme --- README.md | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..99cfbe8 --- /dev/null +++ b/README.md @@ -0,0 +1,29 @@ + +# Gomu (Go Music Player) +Gomu is a Terminal User Interface **TUI** that plays your mp3 files in your local directory. + +[1]: ./gomu.png "screenshot" + +## Features +- lightweight +- show audio files as tree +- simple + +## TODO +- [ ] song fade +- [X] delete song from queue +- [ ] bulk add songs to queue +- [ ] download music from youtube +- [ ] audio streaming +- [ ] music change notification +- [ ] volume change notification +- [ ] delete music from filesystem +- [ ] audio seeking +- [ ] loop +- [ ] total queue duration +- [X] read .mp3 file only +- [ ] add support for .wav as well + + +## Project Background +I just want to implement my own music player with a programming language im currently learning *Go*. Gomu might not be stable as it in constant development. For now, it can do basic music player can do like adding, deleting songs from queue, skip, play, pause but not seeking or more advanced stuff; feel free to contribute :)