0cee99ba4c
* feat: add `info` command line subcommand Adding an info command allows the documentation to refer to it when mentioning platform specific information. This gives users a nicer experience since they don't need to think about how `ncspot` will behave on their system, but can run `ncspot info` to get that information. * fix: info command don't create runtime directory * fix: don't print runtime path on Windows Windows doesn't use the runtime path so it shouldn't be printed there. * fix: make `info` command easier to parse * docs: add back the default configuration directory
47 lines
2.2 KiB
Markdown
47 lines
2.2 KiB
Markdown
<div align="center" style="text-align:center">
|
|
<picture>
|
|
<source media="(prefers-color-scheme: dark)" srcset="images/logo_text_dark.svg">
|
|
<source media="(prefers-color-scheme: light)" srcset="images/logo_text_light.svg">
|
|
<img alt="ncspot logo" height="128" src="images/logo_text_light.svg">
|
|
</picture>
|
|
<h3>An ncurses Spotify client written in Rust using librespot</h3>
|
|
|
|
[](https://crates.io/crates/ncspot)
|
|
[](https://gitter.im/ncspot/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
|
|
|
|
<img alt="ncspot search tab" src="images/screenshot.png">
|
|
</div>
|
|
|
|
ncspot is an ncurses Spotify client written in Rust using librespot. It is heavily inspired by
|
|
ncurses MPD clients, such as [ncmpc](https://musicpd.org/clients/ncmpc/). My motivation was to
|
|
provide a simple and resource friendly alternative to the official client as well as to support
|
|
platforms that currently don't have a Spotify client, such as the \*BSDs.
|
|
|
|
ncspot only works with a Spotify premium account as it offers features that are not available for
|
|
free accounts.
|
|
|
|
## Features
|
|
- Support for tracks, albums, playlists, genres, searching...
|
|
- Small [resource footprint](doc/resource_footprint.md)
|
|
- Support for a lot of platforms
|
|
- Vim keybindings out of the box
|
|
- IPC socket for remote control
|
|
- Automatic authentication using a password manager
|
|
|
|
## Installation
|
|
ncspot is available on macOS (Homebrew), Windows (Scoop), Linux (native package and Flathub) and the
|
|
BSD's. Detailed installation instructions for each platform can be found [here](/doc/users.md).
|
|
|
|
## Configuration
|
|
A configuration file can be provided. The default location is `~/.config/ncspot`. Detailed
|
|
configuration information can be found [here](/doc/users.md#configuration).
|
|
|
|
## Building
|
|
Building ncspot requires a working [Rust installation](https://www.rust-lang.org/tools/install) and
|
|
a Python 3 installation. To compile ncspot, run `cargo build`. For detailed instructions on building
|
|
ncspot, there is more information [here](/doc/developers.md).
|
|
|
|
## Packaging
|
|
Information about provided files, how to generate some of them and current package status accross
|
|
platforms can be found [here](/doc/package_maintainers.md).
|