Skip to content

Commit

Permalink
update readme formatting
Browse files Browse the repository at this point in the history
  • Loading branch information
Mqlvin authored Dec 5, 2024
1 parent 4dd3450 commit 6a1f91d
Showing 1 changed file with 19 additions and 14 deletions.
33 changes: 19 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,35 +1,40 @@
# TermTube
An application for listening to YouTube audio in the terminal, utilising `yt-dlp` and `ffplay`.

## Building
<br>

## Building 🛠️
Install `cargo` from your favourite package manager.

Clone the repo with `git clone git@github.com:Mqlvin/termtube.git`
Move into the cloned directory `cd termtube`
Build with cargo `cargo build --release`
Clone the repo with `git clone git@github.com:Mqlvin/termtube.git`<br>
Move into the cloned directory `cd termtube`<br>
Build with cargo `cargo build --release`<br>

A static binary will be produced at `target/release/termtube`
You can move this binary onto your system PATH to use it anywhere :)
A static binary will be produced at `./target/release/termtube`<br>
You can move this binary on to your system PATH to use it anywhere :)

<br>

## Usage and Running
## Usage and Running 🎶
*Prerequisite: Ensure you have `yt-dlp` and `ffplay` installed and available on your system PATH.*

To get started, type `termtube --help`

#### Basic Usage
A source can be a YouTube video link, a YouTube playlist link, or a source file.
To play YouTube links, type `termtube -s <source> -s <source> -s <source>...`
To play audio, type `termtube --source <source> --source <source> --source <source>...`<br>
A source can be a YouTube video link, a YouTube playlist link, or a source file.<br>
As demonstrated, the `--source` flag (aka `-s`) can be used many times.

#### Using files as a source
You can compile a list of YouTube video links and YouTube playlist links into a file to be supplied to TermTube.
Ensure each link is placed on a new line.
*Note: Adding lots of playlists can significantly increase startup time of TermTube. This is due to extra requests being made to YouTube.*
You can create a list of YouTube video/playlist links in a file to be supplied to TermTube.<br>
Ensure each link is placed on a new line, or the program will not read the file correctly.<br>
*Note: Adding lots of playlists can significantly increase startup time of TermTube. This is due to extra requests being made to YouTube.*<br>

#### Other useful options
For looping, add the `--loop` argument.
For looping, add the `--loop` argument.<br>
For shuffling, add the `--shuffle` argument.

<br>

## Licensing
## Licensing 📄
The project is licensed under the MIT license, which can be found [here](https://github.com/Mqlvin/termtube/blob/master/LICENSE).

0 comments on commit 6a1f91d

Please sign in to comment.