summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorCalum Lind <calumlind+deluge@gmail.com>2019-06-21 10:56:10 +0100
committerCalum Lind <calumlind+deluge@gmail.com>2021-07-31 22:08:23 +0100
commit8fb25f71f30733b24304a09ae401800dfa82324d (patch)
treec92d9e4c9808ba980a78c4bad98cfa2050806f67 /README.md
parenta3332079db827773a1c92b8ef28d1efb12b4e4a2 (diff)
downloaddeluge-8fb25f71f30733b24304a09ae401800dfa82324d.tar.gz
deluge-8fb25f71f30733b24304a09ae401800dfa82324d.tar.bz2
deluge-8fb25f71f30733b24304a09ae401800dfa82324d.zip
[Install] Update and fix python optional requirements
* Added required dependency setuptools to install_requires * Remove optional dependency ipaddress from install_requires * Created extras_require in setup.py. The optional dependencies should not be included in install_requires so that users can either install forked dependencies or remove problematic ones. Updated documentation to detail how to install these optional dependencies. * Fixed README badge Refs: * https://dev.deluge-torrent.org/ticket/3470 * https://dev.deluge-torrent.org/ticket/3282 * https://dev.deluge-torrent.org/ticket/3353
Diffstat (limited to 'README.md')
-rw-r--r--README.md21
1 files changed, 14 insertions, 7 deletions
diff --git a/README.md b/README.md
index 6165c65ea..f0a2139c3 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,6 @@
# Deluge BitTorrent Client
-[![build-status]][travis-deluge] [![docs-status]][rtd-deluge]
+[![build-status]][github-ci] [![docs-status]][rtd-deluge]
Deluge is a BitTorrent client that utilizes a daemon/client model.
It has various user interfaces available such as the GTK-UI, Web-UI and
@@ -13,10 +13,17 @@ From [PyPi](https://pypi.org/project/deluge):
pip install deluge
+with all optional dependencies:
+
+ pip install deluge[all]
+
From source code:
- python setup.py build
- python setup.py install
+ pip install .
+
+with all optional dependencies:
+
+ pip install .[all]
See [DEPENDS](DEPENDS.md) and [Installing/Source] for dependency details.
@@ -56,8 +63,8 @@ See the [Thinclient guide] to connect to the daemon from another computer.
[user guide]: https://dev.deluge-torrent.org/wiki/UserGuide
[thinclient guide]: https://dev.deluge-torrent.org/wiki/UserGuide/ThinClient
[installing/source]: https://dev.deluge-torrent.org/wiki/Installing/Source
-[build-status]: https://travis-ci.org/deluge-torrent/deluge.svg "Travis Status"
-[travis-deluge]: https://travis-ci.org/deluge-torrent/deluge
-[docs-status]: https://readthedocs.org/projects/deluge/badge/?version=develop
-[rtd-deluge]: https://deluge.readthedocs.io/en/develop/?badge=develop "Documentation Status"
+[build-status]: https://github.com/deluge-torrent/deluge/actions/workflows/ci.yml/badge.svg?branch=develop "CI"
+[github-ci]: https://github.com/deluge-torrent/deluge/actions/workflows/ci.yml
+[docs-status]: https://readthedocs.org/projects/deluge/badge/?version=latest
+[rtd-deluge]: https://deluge.readthedocs.io/en/latest/?badge=latest "Documentation Status"
[lt]: https://libtorrent.org