From 4eb5eb70b6a968e32bf7ca60b52103e63b8681da Mon Sep 17 00:00:00 2001 From: "matthias@arch" Date: Mon, 4 Apr 2022 06:14:47 +0200 Subject: [PATCH] Corrected mistakes in readme+man --- PKGBUILD | 2 +- nicole.1.man | 13 +++++++------ nicole.1.md | 11 ++++++----- README.md => readme.md | 12 +++++++----- 4 files changed, 21 insertions(+), 17 deletions(-) rename README.md => readme.md (90%) diff --git a/PKGBUILD b/PKGBUILD index 18b4d69..623a977 100644 --- a/PKGBUILD +++ b/PKGBUILD @@ -8,7 +8,7 @@ url="https:/github.com/MatthiasQuintern/nicole" license=('GPL3') depends=('python-mutagen' 'python-beautifulsoup4') source=(file://${PWD}/nicole/nicole.py _nicole.compdef.zsh nicole.1.man) -md5sums=(93752797fc2bca526fbfd32611518065 f3b46bdcaba5e7fc23bbacc6b2e153c0 19b346a1656bb3db899635d36352dc53) +md5sums=(93752797fc2bca526fbfd32611518065 f3b46bdcaba5e7fc23bbacc6b2e153c0 8c3b8e5c90afdc8993ebab78d48f5668) package() { mkdir -p "${pkgdir}/usr/bin" diff --git a/nicole.1.man b/nicole.1.man index c9ad13a..c31e739 100644 --- a/nicole.1.man +++ b/nicole.1.man @@ -53,8 +53,8 @@ If you don\[cq]t want your files in the history, add the \f[C]-n\f[R] option. .SS genius .PP -Nicole searches for lyrics using the genius api using the -\[lq]title\[rq] and \[lq]artist\[rq] tags of the file. +Nicole searches for lyrics using the genius api with the \[lq]title\[rq] +and \[lq]artist\[rq] tags of the file. If the title and artist names from genius and the tags are similar, the lyrics are scraped from the url obtained through the api. .SS azlyrics @@ -118,7 +118,7 @@ To update nicole, simply follow the installation instructions. .SS pacman (Arch Linux) .PP Installing nicole using the Arch Build System also installs the man-page -and a zsh completion script if you are using zsh as default shell. +and a zsh completion script, if you have zsh installed. .IP .nf \f[C] @@ -129,7 +129,7 @@ makepkg -si .fi .SS pip .PP -Clone this repository and install it using python-pip. +You can also install nicole with python-pip: .IP .nf \f[C] @@ -147,15 +147,16 @@ If you also want to install the man-page and the zsh completion script: .nf \f[C] sudo cp nicole.1.man /usr/share/man/man1/nicole.1 +sudo gzip /usr/share/man/man1/nicole.1 sudo cp _nicole.compdef.zsh /usr/share/zsh/site-functions/_nicole sudo chmod +x /usr/share/zsh/site-functions/_nicole \f[R] .fi .SS Dependencies .IP \[bu] 2 -https://github.com/seebye/mutagen: read and write mp3-tags +https://github.com/quodlibet/mutagen read and write mp3-tags .IP \[bu] 2 -https://www.crummy.com/software/BeautifulSoup/: deal with the html from +https://www.crummy.com/software/BeautifulSoup deal with the html from genius .PP The dependencies will be automatically installed when using the either diff --git a/nicole.1.md b/nicole.1.md index ea2c3a5..dfd292f 100644 --- a/nicole.1.md +++ b/nicole.1.md @@ -30,7 +30,7 @@ Those files are not skipped, the file only exists so that you can see which lyri If you don't want your files in the history, add the `-n` option. ## genius -Nicole searches for lyrics using the genius api using the "title" and "artist" tags of the file. +Nicole searches for lyrics using the genius api with the "title" and "artist" tags of the file. If the title and artist names from genius and the tags are similar, the lyrics are scraped from the url obtained through the api. ## azlyrics @@ -86,7 +86,7 @@ Example: `nicole -ior -d ~/music/artist --rm_explicit` To update nicole, simply follow the installation instructions. ## pacman (Arch Linux) -Installing nicole using the Arch Build System also installs the man-page and a zsh completion script if you are using zsh as default shell. +Installing nicole using the Arch Build System also installs the man-page and a zsh completion script, if you have zsh installed. ```shell git clone https://github.com/MatthiasQuintern/nicole.git cd nicole @@ -94,7 +94,7 @@ makepkg -si ``` ## pip -Clone this repository and install it using python-pip. +You can also install nicole with python-pip: ```shell git clone https://github.com/MatthiasQuintern/nicole.git cd nicole @@ -105,13 +105,14 @@ You can also install it system-wide using `sudo python3 -m pip install.` If you also want to install the man-page and the zsh completion script: ```shell sudo cp nicole.1.man /usr/share/man/man1/nicole.1 +sudo gzip /usr/share/man/man1/nicole.1 sudo cp _nicole.compdef.zsh /usr/share/zsh/site-functions/_nicole sudo chmod +x /usr/share/zsh/site-functions/_nicole ``` ## Dependencies -- https://github.com/seebye/mutagen: read and write mp3-tags -- https://www.crummy.com/software/BeautifulSoup/: deal with the html from genius +- https://github.com/quodlibet/mutagen read and write mp3-tags +- https://www.crummy.com/software/BeautifulSoup deal with the html from genius The dependencies will be automatically installed when using the either of the two installation options. diff --git a/README.md b/readme.md similarity index 90% rename from README.md rename to readme.md index 6af2da5..a496046 100644 --- a/README.md +++ b/readme.md @@ -19,7 +19,7 @@ Those files are not skipped, the file only exists so that you can see which lyri If you don't want your files in the history, add the `-n` option. ### genius -Nicole searches for lyrics using the genius api using the "title" and "artist" tags of the file. +Nicole searches for lyrics using the genius api with the "title" and "artist" tags of the file. If the title and artist names from genius and the tags are similar, the lyrics are scraped from the url obtained through the api. ### azlyrics @@ -54,7 +54,7 @@ Example: `nicole -ior -d ~/music/artist --rm_explicit` To update nicole, simply follow the installation instructions. ### pacman (Arch Linux) -Installing nicole using the Arch Build System also installs the man-page and a zsh completion script if you are using zsh as default shell. +Installing nicole using the Arch Build System also installs the man-page and a zsh completion script, if you have zsh installed. ```shell git clone https://github.com/MatthiasQuintern/nicole.git cd nicole @@ -62,7 +62,7 @@ makepkg -si ``` ### pip -Clone this repository and install it using python-pip. +You can also install nicole with python-pip: ```shell git clone https://github.com/MatthiasQuintern/nicole.git cd nicole @@ -73,13 +73,15 @@ You can also install it system-wide using `sudo python3 -m pip install.` If you also want to install the man-page and the zsh completion script: ```shell sudo cp nicole.1.man /usr/share/man/man1/nicole.1 +sudo gzip /usr/share/man/man1/nicole.1 sudo cp _nicole.compdef.zsh /usr/share/zsh/site-functions/_nicole sudo chmod +x /usr/share/zsh/site-functions/_nicole ``` ### Dependencies -- https://github.com/seebye/mutagen: read and write mp3-tags -- https://www.crummy.com/software/BeautifulSoup/: deal with the html from genius +- https://github.com/quodlibet/mutagen read and write mp3-tags +- https://www.crummy.com/software/BeautifulSoup/ deal with the html from genius + The dependencies will be automatically installed when using the either of the two installation options. ## Changelog