Skip to content

Commit

Permalink
add doc about knowit installation
Browse files Browse the repository at this point in the history
  • Loading branch information
getzze committed Sep 21, 2024
1 parent 1305dac commit 583a95e
Show file tree
Hide file tree
Showing 3 changed files with 33 additions and 0 deletions.
2 changes: 2 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,8 @@ clone your fork locally and install a development version::
$ cd subliminal
$ pip install --user -e '.[dev,test,docs]'

To extract information about the video files, `subliminal` uses `knowit <https://github.com/ratoaq2/knowit`.
For better results, make sure one of its provider is installed, for instance `MediaInfo <https://mediaarea.net/en/MediaInfo>`.

Nautilus/Nemo integration
-------------------------
Expand Down
1 change: 1 addition & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ Documentation
:maxdepth: 2

user/usage
user/installation
user/how_it_works
user/cli
user/provider_guide
Expand Down
30 changes: 30 additions & 0 deletions docs/user/installation.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
Installation
============

From Pypi
---------

For a better isolation with your system you should use a dedicated virtualenv.
The preferred installation method is to use `pipx <https://github.com/pypa/pipx>`_ that does that for you::

$ pipx install subliminal

Subliminal can be also be installed as a regular python module by running::

$ pip install --user subliminal

From source
-----------

If you want to modify the code, `fork <https://github.com/Diaoul/subliminal/fork>`_ this repo,
clone your fork locally and install a development version::

$ git clone https://github.com/<my-username>/subliminal
$ cd subliminal
$ pip install --user -e '.[dev,test,docs]'

External dependencies
---------------------

To extract information about the video files, `subliminal` uses `knowit <https://github.com/ratoaq2/knowit`.
For better results, make sure one of its provider is installed, for instance `MediaInfo <https://mediaarea.net/en/MediaInfo>`.

0 comments on commit 583a95e

Please sign in to comment.