Update 'Home'

abs3nt 2023-01-16 18:45:14 -08:00
parent d929c00ce8
commit 63b9c7f05c

19
Home.md

@ -3,29 +3,29 @@
This is a place for frequently asked questions, solutions to common problems, and general information about gospt. It will be updated slowly overtime as things come up. This is a place for frequently asked questions, solutions to common problems, and general information about gospt. It will be updated slowly overtime as things come up.
# FAQ # FAQ
### Does gospt stream music or do I need to run a Spotify client separately? ## Does gospt stream music or do I need to run a Spotify client separately?
Yes you need to run a Spotify client such as [spotifyd](https://github.com/Spotifyd/spotifyd), [librespot](https://github.com/librespot-org/librespot) or the official Spotify client. Yes you need to run a Spotify client such as [spotifyd](https://github.com/Spotifyd/spotifyd), [librespot](https://github.com/librespot-org/librespot) or the official Spotify client.
### Do I need Spotify premium? ## Do I need Spotify premium?
Yes. Yes.
# Installation # Installation
### From AUR ## From AUR
To install from the aur you can run the following command:```yay -S gospt``` To install from the aur you can run the following command:```yay -S gospt```
If you would like to always have the most recent git version: ```yay -S gospt-git``` If you would like to always have the most recent git version: ```yay -S gospt-git```
### From Releases ## From Releases
Download the most recent binary from [releases](https://gitea.asdf.cafe/abs3nt/gospt/releases) and copy it to somewhere inside your PATH Download the most recent binary from [releases](https://gitea.asdf.cafe/abs3nt/gospt/releases) and copy it to somewhere inside your PATH
Completion scripts are also provided with gospt_yourshellname, download your relevant completion file and place it in your shells completion directory. Completion scripts are also provided with gospt_yourshellname, download your relevant completion file and place it in your shells completion directory.
### From Source ## From Source
To build from source a Makefile is provided: To build from source a Makefile is provided:
@ -38,7 +38,7 @@ If the make file doesn't work for you:
Then copy the built gospt binary to your PATH Then copy the built gospt binary to your PATH
#### Completions ### Completions
```gospt completion bash/zsh/fish``` ```gospt completion bash/zsh/fish```
@ -52,12 +52,11 @@ bash: ```/usr/share/bash-completions/completions/gospt```
# Usage # Usage
To open the TUI: ## TUI
```gospt``` ```gospt```
## CLI
To interact with the CLI:
``` ```
Usage: Usage:
gospt [command] gospt [command]
@ -93,7 +92,7 @@ Use "gospt [command] --help" for more information about a command.
use "gospt --help" to see this page use "gospt --help" to see this page
``` ```
#### Examples: ### Examples:
```gospt volume up``` increases the volume by 10 ```gospt volume up``` increases the volume by 10