From 6c93c44f07536ee26b9e87386376cc8d85d843b9 Mon Sep 17 00:00:00 2001 From: Sudip Ghimire Date: Sat, 20 Nov 2021 20:39:52 +0545 Subject: [PATCH] Add elaborated installation instruction --- README.md | 34 ++++++++++++++++++++++++++++------ 1 file changed, 28 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 00e23b0..827c330 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ Listen to youtube from terminal with a decent tui ## Why ytui-music -Youtube have been go-to platform for many users to stream music. But it is well known that youtube tracks your listening activity for feeding ads. +Youtube have been go-to platform for many of us to stream music. But it is well known that youtube tracks your listening activity for feeding ads. Addition to that one don't always want to open whole browser window just to listen to music because browser takes huge portion of RAM and CPU. Or it is not possible to open a browser window at all like when you are only using cli from ssh or have no GUI at all. @@ -23,15 +23,37 @@ You would also love ## Installing -1. Download the binary from [here](https://github.com/sudipghimire533/ytui-music/releases). Don't forget to select correct architecture and platform. +1) Install mpv and youtube-dl + * mpv: https://mpv.io/installation + * youtube-dl: https://ytdl-ord.github.io/youtube-dl/download.html -2. Install the dependencies. This program depends on youtube-dl and libmpv. Refer to official website of mpv and youtube-dl on how to install them. +2) Download latest binary from [Release page](https://github.com/sudipghtimire533/ytui-music/releases/latest) -* mpv: https://mpv.io/installation/ -* youtbe-dl: https://ytdl-org.github.io/youtube-dl/download.html +3) You should have following directory already existing in your system + * A config root directory where ytui-music can create own directory to store configuration + - Linux: `$HOME/.config` or `$XDG_CONFIG_HOME`. Eg: `/home/alice/.config` + - MacOs: `$HOME/Library/Application Support`. Eg: `/Users/Alice/Library/Application Support` + - Windows: `{FOLDERID_RoamingAppData}`. Eg: C:\Users\Alice\AppData\Roaming + * A music directory where to download data. This can later be changed from configuration and required only when you reset or create configuration for first time + - Linux: `$HOME/Music` or `$XDG_MUSIC_DIR`. Eg: `/home/alice/Music` + - MacOs: `$HOME/Music`. Eg: `/Users/Alice/Music` + - Windows: `{FOLDERID_Music}`. Eg: `C:\Users\Alice\Music` + +4) Start ytui-music + - Show help message: + `ytui_music help` + + - Launch: + `ytui_music run` + + - Show shortcuts/ default keybindings: + `ytui_music info keys` + +5) Show some love +Let me know that you actually have it by giving a [star on github](https://github.com/sudipghimire533/ytui-music) ## Building from source -refer to [build](CONTRIBUTING.md#building) +Refer to [build](CONTRIBUTING.md#building) ## Contributing I would be pleased to know that you have interest to contribute something. This could be anything from suggestion, bug report, issue or the improvement. If you have any suggestion, facing problem or anything feel super duper free to open an issue.