From: Joseph Nuthalapati Date: Fri, 10 Jan 2020 16:48:40 +0000 (+0530) Subject: Rename to Nim Coon X-Git-Tag: 0.1.0~26 X-Git-Url: http://njoseph.me/gitweb/nimcoon.git/commitdiff_plain/3c20e75c565cd0d0eb73ca8060c22bf557aeab89 Rename to Nim Coon Signed-off-by: Joseph Nuthalapati --- diff --git a/.gitignore b/.gitignore index d884fdd..625ed98 100644 --- a/.gitignore +++ b/.gitignore @@ -1 +1 @@ -clitube +nimcoon diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index e9d949b..7597d89 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -6,7 +6,7 @@ stages: compile: stage: build script: - - nim c -d:ssl -d:release clitube.nim + - nim c -d:ssl -d:release nimcoon.nim artifacts: paths: - - clitube + - nimcoon diff --git a/README.md b/README.md index e2174f3..2823d1e 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# CLI Tube +# Nim Coon Play videos from YouTube and PeerTube from the command line using your preferred desktop media player. @@ -6,7 +6,7 @@ command line using your preferred desktop media player. This application is implemented in [Nim language](https://nim-lang.org) using only the standard library. -![clitube screenshot with search term 'baby yoda'](screenshot.png) +![nimcoon screenshot with search term 'baby yoda'](screenshot.png) ## Features @@ -18,11 +18,10 @@ only the standard library. - [ ] Download video - [ ] Download music - [ ] Configuration options -- [ ] Play magnet links ## Installation -CLI Tube depends on the following: +Nim Coon depends on the following: - youtube-dl - mpv (recommended) or vlc - peerflix (for magnet links) @@ -30,7 +29,7 @@ CLI Tube depends on the following: Download the latest build from GitlabCI (amd64 GNU/Linux only). ```sh -wget https://gitlab.com/njoseph/cli-tube/-/jobs/artifacts/master/download?job=compile -O artifacts.zip +wget https://gitlab.com/njoseph/nimcoon/-/jobs/artifacts/master/download?job=compile -O artifacts.zip unzip artifacts.zip ``` @@ -38,7 +37,7 @@ unzip artifacts.zip For other platforms, create a release artifact using the following command: ```sh -nim c -d:ssl -d:release clitube.nim +nim c -d:ssl -d:release nimcoon.nim ``` Copy the binary to a directory on your PATH such as `/usr/local/bin` @@ -46,26 +45,27 @@ Copy the binary to a directory on your PATH such as `/usr/local/bin` ## Usage ```sh -clitube emacs +nimcoon emacs # If your search query has multiple words, use quotes -clitube 'nim lang' +nimcoon 'nim lang' # Advanced: Play audio of the first search result -clitube -m -l "counting stars" +nimcoon -m -l "counting stars" ``` ### Commandline arguments -| **Arguments** | **Explanation** | -|---------------|--------------------------------------------| -| -m, --music | Play Music only, no video | -| -l, --lucky | Try your luck with the first search result | +| **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 | ## Development One-liner for compiling and running ```sh -nim c -d:ssl -r clitube.nim 'nim lang' +nim c -d:ssl -r nimcoon.nim 'nim lang' ``` diff --git a/TODO.org b/TODO.org index f4b6045..cf42d0f 100644 --- a/TODO.org +++ b/TODO.org @@ -1,19 +1,12 @@ -* Task list [5/11] +* Task list [6/11] - [X] Pretty colors in terminal - [X] Get rid of temp file or make one temp file per user - [X] Preferences should go into a config file - [X] Create a proper CLI - [X] PeerTube support (only direct download, because webtorrent seeds are too slow) +- [X] Find a better name. clitube is an SEO disaster - [ ] Terminal color themes? - [ ] SoundCloud support? - [ ] Spawn video player and quit immediately - [ ] LRU cache of content so that frequently-played content doesn't use BW - [ ] Option to download audio/video -- [ ] Find a better name. clitube is an SEO disaster - - nimstream - - nimp (Urban Dictionary isn't kind about this one) - - nimtube (There's a nimtube.com) - - mytube (taken) -- metube (some Windows 10 app) -- ourtube -- nimcoon 😍 diff --git a/clitube.nim b/nimcoon.nim similarity index 100% rename from clitube.nim rename to nimcoon.nim diff --git a/screenshot.png b/screenshot.png index 39bdf85..d8a760d 100644 Binary files a/screenshot.png and b/screenshot.png differ