From 1865ece67659ffc26d32ea4400fc6b5f94c2aed2 Mon Sep 17 00:00:00 2001 From: getzze Date: Wed, 3 Jul 2024 18:39:54 +0100 Subject: [PATCH] update README with newer infos --- README.rst | 30 ++++++++++++++++++++---------- 1 file changed, 20 insertions(+), 10 deletions(-) diff --git a/README.rst b/README.rst index 0793b821..a5ed2d52 100644 --- a/README.rst +++ b/README.rst @@ -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 @@ -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 `_ 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 `_ this repo, +clone your fork locally and install a development version:: + + $ git clone https://github.com//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 `_ for more information. + +Dolphin integration +------------------- +See this `Gist `_.