X-Git-Url: https://njoseph.me/gitweb/nimcoon.git/blobdiff_plain/26229fac9c93a427a85e86b899ed54639116de9a..9ed70b9e0ee8ebf8e0b1fc1bbe1b77178d1f008c:/README.md diff --git a/README.md b/README.md index 6bac1ee..7de80d0 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,23 @@ # NimCoon -Play videos from YouTube and PeerTube from the -command line using your preferred desktop media player. +Play videos from YouTube and PeerTube from the command line using your preferred desktop media player. -NewPipe app for Android offers similar features. +Similar apps for other platforms: -This application is implemented in [Nim language](https://nim-lang.org) using -only the standard library. +- [NewPipe](https://newpipe.schabi.org) is a light-weight YouTube frontend for Android +- [FreeTube](https://freetubeapp.io) is a GUI client for desktop platforms (uses electron) + +This is a minimal application implemented in [Nim language](https://nim-lang.org) using only the standard library. ![nimcoon screenshot with search term 'baby yoda'](screenshot.png) +## Logo + +A Maine Coon cat wearing a golden crown. +Logo contributions/suggestions welcome. + +Maybe I would've just called this project Maine Coon had I written it in Python, but I wanted to use this opportunity to make Nim popular. + ## Motivation ### No similar existing tool @@ -135,16 +143,38 @@ again. ### Command line arguments -| **Arguments** | **Explanation** | -|-------------------|--------------------------------------------| -| -m, --music | Play Music only, no video | -| -l, --lucky | Try your luck with the first search result | -| -f, --full-screen | Play video in full screen | -| -d, --download | Download video or music | +NimCoon provides both interactive and non-interactive arguments with significant +overlap. But some arguments might only be present in one mode. + +Non-interactive arguments are specified to the nimcoon program and apply +globally to all search results in that session. These can be overriden on a +case-by-case basis using the interactive arguments. + +| **Non-interactive Arguments** | **Explanation** | +|-------------------------------|--------------------------------------------| +| -m, --music | Play Music only, no video | +| -l, --lucky | Try your luck with the first search result | +| -f, --full-screen | Play video in full screen | +| -d, --download | Download video or music | Feel free to use these options in any combination. NimCoon will show a helpful error message if you pick incompatible options. +Interactive arguments are provided during selection of a search result. These +options allow you to change your mind after performing the search. For example, +you might have searched for a music video, watched it and want to download the +music only. In this case, you can specify the search result followed by the +options as single characters. i.e + +"1" plays the video +"1 md" downloads the music of the video + +| **Interactive Arguments** | **Explanation** | +|---------------------------|---------------------------| +| -m, --music | Play Music only, no video | +| -f, --full-screen | Play video in full screen | +| -d, --download | Download video or music | + ## Development One-liner for compiling and running