MatthiasQuintern/nicole
1
1
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Corrected mistakes in readme+man

Browse Source
This commit is contained in:
matthias@arch 2022-04-04 06:14:47 +02:00
parent cbb5029555
commit 4eb5eb70b6
4 changed files with 21 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
PKGBUILD
View File

@ -8,7 +8,7 @@ url="https:/github.com/MatthiasQuintern/nicole"
license=('GPL3') license=('GPL3')
depends=('python-mutagen' 'python-beautifulsoup4') depends=('python-mutagen' 'python-beautifulsoup4')
source=(file://${PWD}/nicole/nicole.py _nicole.compdef.zsh nicole.1.man) source=(file://${PWD}/nicole/nicole.py _nicole.compdef.zsh nicole.1.man)
md5sums=(93752797fc2bca526fbfd32611518065 f3b46bdcaba5e7fc23bbacc6b2e153c0 19b346a1656bb3db899635d36352dc53) md5sums=(93752797fc2bca526fbfd32611518065 f3b46bdcaba5e7fc23bbacc6b2e153c0 8c3b8e5c90afdc8993ebab78d48f5668)
package() { package() {
mkdir -p "${pkgdir}/usr/bin" mkdir -p "${pkgdir}/usr/bin"

13
nicole.1.man
View File

@ -53,8 +53,8 @@ If you don\[cq]t want your files in the history, add the \f[C]-n\f[R]
option. option.
.SS genius .SS genius
.PP .PP
Nicole searches for lyrics using the genius api using the Nicole searches for lyrics using the genius api with the \[lq]title\[rq]
\[lq]title\[rq] and \[lq]artist\[rq] tags of the file. and \[lq]artist\[rq] tags of the file.
If the title and artist names from genius and the tags are similar, the If the title and artist names from genius and the tags are similar, the
lyrics are scraped from the url obtained through the api. lyrics are scraped from the url obtained through the api.
.SS azlyrics .SS azlyrics
@ -118,7 +118,7 @@ To update nicole, simply follow the installation instructions.
.SS pacman (Arch Linux) .SS pacman (Arch Linux)
.PP .PP
Installing nicole using the Arch Build System also installs the man-page 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 .IP
.nf .nf
\f[C] \f[C]
@ -129,7 +129,7 @@ makepkg -si
.fi .fi
.SS pip .SS pip
.PP .PP
Clone this repository and install it using python-pip. You can also install nicole with python-pip:
.IP .IP
.nf .nf
\f[C] \f[C]
@ -147,15 +147,16 @@ If you also want to install the man-page and the zsh completion script:
.nf .nf
\f[C] \f[C]
sudo cp nicole.1.man /usr/share/man/man1/nicole.1 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 cp _nicole.compdef.zsh /usr/share/zsh/site-functions/_nicole
sudo chmod +x /usr/share/zsh/site-functions/_nicole sudo chmod +x /usr/share/zsh/site-functions/_nicole
\f[R] \f[R]
.fi .fi
.SS Dependencies .SS Dependencies
.IP \[bu] 2 .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 .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 genius
.PP .PP
The dependencies will be automatically installed when using the either The dependencies will be automatically installed when using the either

11
nicole.1.md
View File

@ -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. If you don't want your files in the history, add the `-n` option.
## genius ## 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. 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 ## azlyrics
@ -86,7 +86,7 @@ Example: `nicole -ior -d ~/music/artist --rm_explicit`
To update nicole, simply follow the installation instructions. To update nicole, simply follow the installation instructions.
## pacman (Arch Linux) ## 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 ```shell
git clone https://github.com/MatthiasQuintern/nicole.git git clone https://github.com/MatthiasQuintern/nicole.git
cd nicole cd nicole
@ -94,7 +94,7 @@ makepkg -si
``` ```
## pip ## pip
Clone this repository and install it using python-pip. You can also install nicole with python-pip:
```shell ```shell
git clone https://github.com/MatthiasQuintern/nicole.git git clone https://github.com/MatthiasQuintern/nicole.git
cd nicole 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: If you also want to install the man-page and the zsh completion script:
```shell ```shell
sudo cp nicole.1.man /usr/share/man/man1/nicole.1 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 cp _nicole.compdef.zsh /usr/share/zsh/site-functions/_nicole
sudo chmod +x /usr/share/zsh/site-functions/_nicole sudo chmod +x /usr/share/zsh/site-functions/_nicole
``` ```
## Dependencies ## Dependencies
- https://github.com/seebye/mutagen: read and write mp3-tags - https://github.com/quodlibet/mutagen read and write mp3-tags
- https://www.crummy.com/software/BeautifulSoup/: deal with the html from genius - 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. The dependencies will be automatically installed when using the either of the two installation options.

12
README.md → readme.md
View File

@ -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. If you don't want your files in the history, add the `-n` option.
### genius ### 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. 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 ### azlyrics
@ -54,7 +54,7 @@ Example: `nicole -ior -d ~/music/artist --rm_explicit`
To update nicole, simply follow the installation instructions. To update nicole, simply follow the installation instructions.
### pacman (Arch Linux) ### 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 ```shell
git clone https://github.com/MatthiasQuintern/nicole.git git clone https://github.com/MatthiasQuintern/nicole.git
cd nicole cd nicole
@ -62,7 +62,7 @@ makepkg -si
``` ```
### pip ### pip
Clone this repository and install it using python-pip. You can also install nicole with python-pip:
```shell ```shell
git clone https://github.com/MatthiasQuintern/nicole.git git clone https://github.com/MatthiasQuintern/nicole.git
cd nicole 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: If you also want to install the man-page and the zsh completion script:
```shell ```shell
sudo cp nicole.1.man /usr/share/man/man1/nicole.1 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 cp _nicole.compdef.zsh /usr/share/zsh/site-functions/_nicole
sudo chmod +x /usr/share/zsh/site-functions/_nicole sudo chmod +x /usr/share/zsh/site-functions/_nicole
``` ```
### Dependencies ### Dependencies
- https://github.com/seebye/mutagen: read and write mp3-tags - https://github.com/quodlibet/mutagen read and write mp3-tags
- https://www.crummy.com/software/BeautifulSoup/: deal with the html from genius - 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. The dependencies will be automatically installed when using the either of the two installation options.
## Changelog ## Changelog