UPDATE README
This commit is contained in:
parent
05935c152a
commit
2df207102c
27
README.md
27
README.md
|
@ -4,16 +4,29 @@
|
||||||
|
|
||||||
MPD client inspired by ncmpcpp written in GO
|
MPD client inspired by ncmpcpp written in GO
|
||||||
|
|
||||||
|
|
||||||
https://user-images.githubusercontent.com/51816057/141670212-34b62601-19b0-40c0-8797-f21bce2e11f3.mp4
|
https://user-images.githubusercontent.com/51816057/141670212-34b62601-19b0-40c0-8797-f21bce2e11f3.mp4
|
||||||
|
|
||||||
|
|
||||||
|
- [goMP](#gomp)
|
||||||
|
- [Roadmap](#roadmap)
|
||||||
|
- [Setting Up](#setting-up)
|
||||||
|
- [Installing / Building](#installing--building)
|
||||||
|
- [Configuration](#configuration)
|
||||||
|
- [Image Rendering :](#image-rendering-)
|
||||||
|
- [Key Mappings](#key-mappings)
|
||||||
|
- [Getting Album Art from LastFm API](#getting-album-art-from-lastfm-api)
|
||||||
|
- [Tested on following terminals:](#tested-on-following-terminals)
|
||||||
|
|
||||||
# Roadmap
|
# Roadmap
|
||||||
|
|
||||||
|
|
||||||
- [ ] Add Functionality to Sort out most played songs
|
- [ ] Add Functionality to Sort out most played songs
|
||||||
- [x] Add a config parser
|
- [x] Add a config parser
|
||||||
- [x] Image Previews
|
- [x] Image Previews
|
||||||
- [x] User Key Mappings
|
- [x] User Key Mappings
|
||||||
- [x] Querying LastFM API for getting Album Art
|
- [x] Querying LastFM API for getting Album Art
|
||||||
- [ ] Fuzzy Searching
|
- [x] Fuzzy Searching [ checkout [this pull request](https://github.com/aditya-K2/goMP/pull/8) ]
|
||||||
- [ ] Visual Mode (like vim) for updating playlists
|
- [ ] Visual Mode (like vim) for updating playlists
|
||||||
|
|
||||||
# Setting Up
|
# Setting Up
|
||||||
|
@ -33,6 +46,14 @@ go build
|
||||||
|
|
||||||
# Configuration
|
# Configuration
|
||||||
|
|
||||||
|
## Image Rendering :
|
||||||
|
|
||||||
|
The Default Position of the Image without any configuration assumes that you have no padding or margin so Image will
|
||||||
|
be rendered at different places in different terminals, Also the TUI calculates positions with the help of rows and columns
|
||||||
|
and the image is rendered at pixel positions so the exact position can't be defined [ the app tries its best by calculating
|
||||||
|
the font width and then predicting the position but it is best that you define extra padding and own image width ratio
|
||||||
|
in config.yml. Please Read more about it in the [sample_config](https://github.com/aditya-K2/goMP/blob/master/sample_config.yml)
|
||||||
|
|
||||||
## Key Mappings
|
## Key Mappings
|
||||||
|
|
||||||
Following Keys can be used for Mappings
|
Following Keys can be used for Mappings
|
||||||
|
@ -79,10 +100,12 @@ Following functions are provided :
|
||||||
| navigateToFiles |
|
| navigateToFiles |
|
||||||
| navigateToPlaylist |
|
| navigateToPlaylist |
|
||||||
| navigateToMostPlayed |
|
| navigateToMostPlayed |
|
||||||
|
| navigateToSearch |
|
||||||
| quit |
|
| quit |
|
||||||
| stop |
|
| stop |
|
||||||
| updateDB |
|
| updateDB |
|
||||||
| deleteSongFromPlaylist |
|
| deleteSongFromPlaylist |
|
||||||
|
| FocusSearch |
|
||||||
|
|
||||||
## Getting Album Art from [LastFm API](https://www.last.fm/api)
|
## Getting Album Art from [LastFm API](https://www.last.fm/api)
|
||||||
|
|
||||||
|
@ -113,4 +136,4 @@ LASTFM_AUTO_CORRECT: 1 # 0 means it is turned off
|
||||||
|
|
||||||
- Alacritty
|
- Alacritty
|
||||||
- ST
|
- ST
|
||||||
- URXVT
|
- URXVT ( URXVT sometimes crashes when downloading coverart from lastfm )
|
||||||
|
|
Loading…
Reference in New Issue