From 01fe1bb68aff73ca1102f8b18776ec8012b79aab Mon Sep 17 00:00:00 2001 From: ksyasuda Date: Wed, 16 Feb 2022 23:57:43 -0800 Subject: [PATCH] apply autoformatter to markdown files --- README.md | 43 +++++++++++++++++++++------------------- docs/man/aniwrapper.1 | 9 +++------ docs/man/aniwrapper.1.md | 20 +++++++++---------- 3 files changed, 36 insertions(+), 36 deletions(-) diff --git a/README.md b/README.md index 0973ca9..c9ef4d5 100644 --- a/README.md +++ b/README.md @@ -33,18 +33,18 @@ This tool scrapes the site [gogoanime](https://gogoanime.cm). - [Introduction](#introduction) - [MPV Extension - Skip Intro Script](#mpv-extension---skip-intro-script) - [Installing](#installing) - - [Manual Install](#manual-install) + - [Manual Install](#manual-install) - [Aniwrapper Menus](#aniwrapper-menus) - [Dealing with conflicting search queries / rofi grabbing from search list](#dealing-with-conflicting-search-queries--rofi-grabbing-from-search-list) - [Usage](#usage) - - [aniwrapper](#aniwrapper-1) - - [Option 1: Streaming](#option-1-streaming) - - [Option 2: Download](#option-2-download) - - [Option 3: Continue](#option-3-continue) - - [Option 4: Play from File](#option-4-play-from-file) - - [Option 5: Sync History](#option-5-sync-history) - - [Option 6: Choose Theme](#option-6-choose-theme) - - [ani-cli](#ani-cli) + - [aniwrapper](#aniwrapper-1) + - [Option 1: Streaming](#option-1-streaming) + - [Option 2: Download](#option-2-download) + - [Option 3: Continue](#option-3-continue) + - [Option 4: Play from File](#option-4-play-from-file) + - [Option 5: Sync History](#option-5-sync-history) + - [Option 6: Choose Theme](#option-6-choose-theme) + - [ani-cli](#ani-cli) - [Themes](#themes) @@ -60,13 +60,13 @@ script for MPV during setup if it is not already installed_ Upon activation, the skip-intro script will try its best to skip the episode introduction by skipping to the next moment of silence in the video -- If the video has not pre-loaded past the introduction, the script will not - know what to do. Press `TAB` again to stop the script until the video - has loaded enough, or just manually skip past the intro. -- If the video does not have a pause in audio (or a significant enough drop in - audio volume) between the end of the introduction and the beginning of the - video/episode, then the script may fail and skip to a random point in the - video +- If the video has not pre-loaded past the introduction, the script will not + know what to do. Press `TAB` again to stop the script until the video + has loaded enough, or just manually skip past the intro. +- If the video does not have a pause in audio (or a significant enough drop in + audio volume) between the end of the introduction and the beginning of the + video/episode, then the script may fail and skip to a random point in the + video # Installing @@ -125,7 +125,7 @@ In this program, rofi is configured to search with case insensitivity and select Once your history starts filling up, it becomes progressively more difficult to form unique search queries ![selection with dash](https://imgur.com/vSyaoG6.png) -A workaround for this is to append a dash ` -` to the end of the search query
+A workaround for this is to append a dash `-` to the end of the search query
The above output was produced by searching: `isekai -` @@ -156,6 +156,9 @@ aniwrapper -T # Specify custom rofi config aniwrapper -v # Enable verbose logging ``` +> Half-episodes (ex. saihate-no-paladin episode 7.5) are selectable, however they will not show up in the episodes list. +> To select half episodes add 'h' to the beginning for episodes like '7.5' -> 'h7' to select saihate-no-paladin episode 7.5 + See [aniwrapper menus](docs/aniwrapper-menus.md) for more information about the menus used in the following options ### Option 1: Streaming @@ -226,9 +229,9 @@ This option allows you to sync your search/watch history across devices. It quer At the moment, the requirements are as follows: -- You must be able to `ssh` into the remote machine -- The username must be the same across both devices -- The `history.sqlite3` file must be in the default location: `$XDG_CONFIG_HOME/aniwrapper/history.sqlite3` +- You must be able to `ssh` into the remote machine +- The username must be the same across both devices +- The `history.sqlite3` file must be in the default location: `$XDG_CONFIG_HOME/aniwrapper/history.sqlite3` ### Option 6: Choose Theme diff --git a/docs/man/aniwrapper.1 b/docs/man/aniwrapper.1 index a2109c2..e03cb90 100644 --- a/docs/man/aniwrapper.1 +++ b/docs/man/aniwrapper.1 @@ -5,7 +5,7 @@ .SH NAME .PP aniwrapper - A rofi wrapper around ani-cli: a command-line tool to -browser, download, and stream anime +stream, download, and play anime .SH SYNOPSIS .PP \f[B]aniwrapper\f[R] [-dhpqSv] [-t \f[I]theme\f[R] | -T @@ -27,15 +27,12 @@ browser, download, and stream anime .P .PD \f[B]aniwrapper\f[R] -C -.PD 0 -.P -.PD .SH DESCRIPTION .PP \f[B]aniwrapper\f[R] is a wrapper around a modified version of \f[B]ani-cli\f[R], which uses \f[B]rofi\f[R] to get user input and control the program flow, as well as a a \f[B]sqlite3\f[R] database for -tracking search/watch history. +tracking search/watch history .SH OPTIONS .PP Defaults: @@ -122,4 +119,4 @@ notifications) Written by Kyle Yasuda .PP Original code based on pystardust\[cq]s \f[I]ani-cli\f[R] -(https://github.com/pystardust/ani-cli) +() diff --git a/docs/man/aniwrapper.1.md b/docs/man/aniwrapper.1.md index 66f9551..c1ca0eb 100644 --- a/docs/man/aniwrapper.1.md +++ b/docs/man/aniwrapper.1.md @@ -8,29 +8,29 @@ date: February 4, 2022 # NAME -aniwrapper - A rofi wrapper around ani-cli: a command-line tool to browser, download, and stream anime +aniwrapper - A rofi wrapper around ani-cli: a command-line tool to stream, download, and play anime # SYNOPSIS -**aniwrapper** [-dhpqSv] [-t _theme_ | -T *config_path*] [*query*]\ -**aniwrapper** -f _directory_path_ [-t _theme_ | -T *config_path*] [-pSv] [*query*]\ -**aniwrapper** -c [-dhpqSv] [*query*]\ +**aniwrapper** [-dhpqSv] [-t _theme_ | -T _config_path_] [_query_]\ +**aniwrapper** -f _directory_path_ [-t _theme_ | -T _config_path_] [-pSv] [_query_]\ +**aniwrapper** -c [-dhpqSv] [_query_]\ **aniwrapper** -Q _query_\ -**aniwrapper** -C\ +**aniwrapper** -C # DESCRIPTION **aniwrapper** is a wrapper around a modified version of **ani-cli**, which uses **rofi** to get user input and control the program flow, as well as a -a **sqlite3** database for tracking search/watch history. +a **sqlite3** database for tracking search/watch history # OPTIONS Defaults: -- **rofi** enabled -- aniwrapper.rasi theme -- best quality +- **rofi** enabled +- aniwrapper.rasi theme +- best quality **-c** : Enable command-line mode (disable **rofi**) @@ -103,4 +103,4 @@ Defaults: Written by Kyle Yasuda -Original code based on pystardust's _ani-cli_ (https://github.com/pystardust/ani-cli) +Original code based on pystardust's _ani-cli_ ()