summaryrefslogtreecommitdiffstats
path: root/docs/source/intro/01-install.md
diff options
context:
space:
mode:
authorCalum Lind <calumlind+deluge@gmail.com>2019-06-05 23:32:37 +0100
committerCalum Lind <calumlind+deluge@gmail.com>2019-06-06 17:12:58 +0100
commitd4185505d1845c59881518b8699868a867fdbe75 (patch)
tree6fa1bdec02b6f8225da24e12acf77e36321e18c2 /docs/source/intro/01-install.md
parent04e58659febdcd9f371f49d33999af3654f13e11 (diff)
downloaddeluge-d4185505d1845c59881518b8699868a867fdbe75.tar.gz
deluge-d4185505d1845c59881518b8699868a867fdbe75.tar.bz2
deluge-d4185505d1845c59881518b8699868a867fdbe75.zip
[Docs] Cleanup changelog and docs
Diffstat (limited to 'docs/source/intro/01-install.md')
-rw-r--r--docs/source/intro/01-install.md52
1 files changed, 33 insertions, 19 deletions
diff --git a/docs/source/intro/01-install.md b/docs/source/intro/01-install.md
index a60380f91..28941796f 100644
--- a/docs/source/intro/01-install.md
+++ b/docs/source/intro/01-install.md
@@ -1,43 +1,52 @@
# Installing Deluge
-These are the instructions for installer Deluge. They are a work-in-progress and feel
-free to make suggestions for improvement.
+These are the instructions for installing Deluge. Consider them a work-in-progress and
+feel free to make suggestions for improvement.
-## Ubuntu
+## <i class="icon-ubuntu"></i> Ubuntu
### PPA
-https://launchpad.net/~deluge-team/+archive/ubuntu/develop/
+Until the stable PPA is updated, the development version of Deluge can be used:
-### PyPi
+ sudo add-apt-repository -u ppa:deluge-team/develop
+ sudo apt install deluge
-Deluge requires the following system installed packages:
+### <i class="icon-python"></i> PyPi
+
+To install from Python PyPi, Deluge requires the following system installed packages:
sudo apt install python3-pip python3-libtorrent python3-gi python3-gi-cairo gir1.2-gtk-3.0 gir1.2-appindicator3
Install with pip:
- pip install --user deluge
+ pip install deluge
-## Windows
+## <i class="fa fa-windows"></i> Windows
There is no installer package currently for Windows, but can try Deluge as follows.
-1. Install Python 3.6.
-2. Download and extract the `gvsbuild`.
-3. Open a terminal.
-4. Add directory to PATH: `set PATH=C:\gvsbuild\release;%PATH%`
-5. Install Python wheels from gvsbuild:
- pip install C:\gvsbuild\release\python\pycairo-1.17.1-cp36-cp36m-win_amd64.whl
- pip install C:\gvsbuild\release\python\PyGObject-3.28.3-py3.6-win-amd64.whl
-6. Install Deluge
- pip install deluge deluge-libtorrent
+1. Download and install [Python 3.6].
+2. Download and extract [gvsbuild] tarball to `C:\`.
+3. Open a terminal.
+4. Run this command to add `gvsbuild` directory to `PATH`:
+
+ set PATH=C:\gvsbuild\release;%PATH%
+
+5. Install `gvsbuild` Python wheels:
+
+ pip install C:\gvsbuild\release\python\pycairo-1.18.0-cp36-cp36m-win_amd64.whl
+ pip install C:\gvsbuild\release\python\PyGObject-3.32.0-cp36-cp36m-win_amd64.whl
-## macOS
+6. Install Deluge:
+
+ pip install deluge deluge-libtorrent
+
+## <i class="fa fa-apple"></i> macOS
There is no `.app` package currently for macOS, but can try Deluge with homebrew.
-1. Install [Homebrew](https://brew.sh/)
+1. Install [Homebrew]
2. Open a terminal.
3. Run the following to install required packages:
@@ -51,3 +60,8 @@ There is no `.app` package currently for macOS, but can try Deluge with homebrew
5. Install Deluge:
pip3 install deluge
+
+[develop ppa]: https://launchpad.net/~deluge-team/+archive/ubuntu/develop/
+[homebrew]: https://brew.sh/
+[python 3.6]: https://www.python.org/downloads/release/python-368/
+[gvsbuild]: https://ci.appveyor.com/api/buildjobs/b0y2sttcq3t1071q/artifacts/gvsbuild-vs14-x64.tar.gz