chore: update readme and fix dependencies

This commit is contained in:
Ales (Shagi) Zabala Alava 2024-08-29 18:32:42 +02:00
parent 6ce2b7b853
commit ab0fa88315
3 changed files with 25 additions and 10 deletions

View File

@ -1,11 +1,24 @@
Negro Mate Songs
================
NegroMate's song database library.
Negro Mate's song database library. Not much versatile without two another packages:
Install from source
-------------------
Instalation uses the pep517 packaging format, whichs requires pip version
19 or newer.
* [negromate.web](https://pypi.org/project/negromate.web/): Static html compiler for the web of Negro Mage
* [negromate.karaoke](https://pypi.org/project/negromate.karaoke/): Simple karaoke video browser
pip install "pip>=19"
pip install .
Provides the base `negromate` command to interact with a song repository.
negromate config: Write the configuration file
negromate songs: Update song database
negromate thumbnail: Generate cover and thumbnail for a song
Needs the following packages installed:
* imagemagick
* ffmpeg
Karaoke subtitle generation is currently broken, it worked with these
packages on older systems:
* xdotool
* aegisub
* xserver-xephyr

View File

@ -1,3 +1,4 @@
webvtt-py
ass==0.5.2
webvtt-py==0.4.6
asstosrt==0.1.6
srt==3.5.3

View File

@ -6,10 +6,10 @@ version = attr: negromate.songs.VERSION
license-file = LICENSE.txt
author = Ales (Shagi) Zabala Alava
author_email = shagi@gisa-elkartea.org
url = http://negromate.rocks
url = https://negromate.rocks
description = NegroMate karaoke song database library
long_description_content_type = text/markdown
long_description = files: README.md, CHANGELOG.md
long_description = file: README.md, CHANGELOG.md
license = GPLv3
classifiers =
Development Status :: 5 - Production/Stable
@ -26,6 +26,7 @@ install_requires =
webvtt-py
asstosrt ==0.1.6
srt ==3.5.3
ass ==0.5.2
[options.entry_points]
console_scripts =