Rename to Nim Coon
authorJoseph Nuthalapati <njoseph@riseup.net>
Fri, 10 Jan 2020 16:48:40 +0000 (22:18 +0530)
committerJoseph Nuthalapati <njoseph@riseup.net>
Fri, 10 Jan 2020 16:52:52 +0000 (22:22 +0530)
Signed-off-by: Joseph Nuthalapati <njoseph@riseup.net>
.gitignore
.gitlab-ci.yml
README.md
TODO.org
nimcoon.nim [moved from clitube.nim with 100% similarity]
screenshot.png

index d884fdda27d81fb0255f52314112ab73d7aa82dd..625ed9854219dd2e08cb94e94970eae3aee08de7 100644 (file)
@@ -1 +1 @@
-clitube
+nimcoon
index e9d949b3a0a08b8a8ce9f9a462cb99b2ca11c606..7597d89e387da1f12a0be2ac3de0347653fdccc7 100644 (file)
@@ -6,7 +6,7 @@ stages:
 compile:
   stage: build
   script:
 compile:
   stage: build
   script:
-    - nim c -d:ssl -d:release clitube.nim
+    - nim c -d:ssl -d:release nimcoon.nim
   artifacts:
     paths:
   artifacts:
     paths:
-      - clitube
+      - nimcoon
index e2174f3481c7cf5ffa7e2f83940fac73d5d9c8ef..2823d1e2d1a8da0a837f7ab06186f4497ab0d626 100644 (file)
--- 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.
 
 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.
 
 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
 
 
 ## Features
 
@@ -18,11 +18,10 @@ only the standard library.
 - [ ] Download video
 - [ ] Download music
 - [ ] Configuration options
 - [ ] Download video
 - [ ] Download music
 - [ ] Configuration options
-- [ ] Play magnet links
 
 ## Installation
 
 
 ## Installation
 
-CLI Tube depends on the following:
+Nim Coon depends on the following:
 - youtube-dl
 - mpv (recommended) or vlc
 - peerflix (for magnet links)
 - 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
 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
 ```
 
 unzip artifacts.zip
 ```
 
@@ -38,7 +37,7 @@ unzip artifacts.zip
 For other platforms, create a release artifact using the following command:
 
 ```sh
 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`
 ```
 
 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
 ## Usage
 
 ```sh
-clitube emacs
+nimcoon emacs
 
 # If your search query has multiple words, use quotes
 
 # If your search query has multiple words, use quotes
-clitube 'nim lang'
+nimcoon 'nim lang'
 
 # Advanced: Play audio of the first search result
 
 # Advanced: Play audio of the first search result
-clitube -m -l "counting stars"
+nimcoon -m -l "counting stars"
 ```
 
 ### Commandline arguments
 
 ```
 
 ### 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
 
 ## 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'
 ```
 ```
index f4b60457b01df65d8085f039f04617bfe657b891..cf42d0fb5fa0d47d1148d970b758d5daeb04fad6 100644 (file)
--- 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] 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
 - [ ] 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 😍
similarity index 100%
rename from clitube.nim
rename to nimcoon.nim
index 39bdf85d90e8573f837e373681e19b77d27f92c0..d8a760d2e8656ff85d64c7675bd63c04bdbe7270 100644 (file)
Binary files a/screenshot.png and b/screenshot.png differ