Skip to content

Commit

Permalink
update README with newer infos
Browse files Browse the repository at this point in the history
  • Loading branch information
getzze committed Jul 4, 2024
1 parent d9a8af0 commit 1865ece
Showing 1 changed file with 20 additions and 10 deletions.
30 changes: 20 additions & 10 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,16 +6,12 @@ Subtitles, faster than your thoughts.
:target: https://pypi.python.org/pypi/subliminal
:alt: Latest Version

.. image:: https://travis-ci.org/Diaoul/subliminal.svg?branch=develop
:target: https://travis-ci.org/Diaoul/subliminal
:alt: Travis CI build status

.. image:: https://readthedocs.org/projects/subliminal/badge/?version=latest
:target: https://subliminal.readthedocs.org/
:alt: Documentation Status

.. image:: https://coveralls.io/repos/Diaoul/subliminal/badge.svg?branch=develop&service=github
:target: https://coveralls.io/github/Diaoul/subliminal?branch=develop
.. image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/Diaoul/subliminal/python-coverage-comment-action-data/endpoint.json
:target: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/Diaoul/subliminal/python-coverage-comment-action-data/endpoint.json
:alt: Code coverage

.. image:: https://img.shields.io/github/license/Diaoul/subliminal.svg
Expand Down Expand Up @@ -77,13 +73,27 @@ Run subliminal in a docker container::

Installation
------------
Subliminal can be installed as a regular python module by running::
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::

$ [sudo] pip install subliminal
$ pip install --user subliminal

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]'

For a better isolation with your system you should use a dedicated virtualenv or install for your user only using
the ``--user`` flag.

Nautilus/Nemo integration
-------------------------
See the dedicated `project page <https://github.com/Diaoul/nautilus-subliminal>`_ for more information.

Dolphin integration
-------------------
See this `Gist <https://gist.github.com/maurocolella/03a9f02c56b1a90c64f05683e2840d57>`_.

0 comments on commit 1865ece

Please sign in to comment.