Update README and add a DEPENDS file that lists the dependencies

This commit is contained in:
Andrew Resch 2009-07-15 02:50:26 +00:00
parent e9d7b71fe8
commit 35136b652d
2 changed files with 49 additions and 42 deletions

31
DEPENDS Normal file
View File

@ -0,0 +1,31 @@
Core:
python >= 2.5
twisted
twisted-web
pyopenssl
simplejson (if python < 2.6)
setuptools
gettext
pyxdg
geoip-database (optional)
libtorrent >= 0.14, or build the included version
If building included libtorrent:
boost >= 1.34.1
openssl
zlib
UIs:
chardet
Gtk:
python-notify (libnotify python wrapper)
pygame
pygtk >= 2.12
librsvg
xdg-utils
Web:
mako

60
README
View File

@ -2,15 +2,13 @@
Deluge BitTorrent Client Deluge BitTorrent Client
========================== ==========================
Authors:
Andrew Resch
Marcos Pinto
Martijn Voncken
Sadrul Habib Chowdhury
Damien Churchill
Homepage: http://deluge-torrent.org Homepage: http://deluge-torrent.org
Authors:
Andrew Resch
Damien Churchill
For past developers and contributers see: http://dev.deluge-torrent.org/wiki/About
========================== ==========================
License License
@ -27,39 +25,17 @@ Contact/Support:
We have two options available for support: We have two options available for support:
Our Forum, at http://forum.deluge-torrent.org Our Forum, at: http://forum.deluge-torrent.org
or or
Our IRC Channel, at #deluge on Freenode Our IRC Channel, at #deluge on Freenode: http://freenode.net
========================== ==========================
Installation Instructions: Installation Instructions:
========================== ==========================
Dependencies: For more detailed instructions see: http://dev.deluge-torrent.org/wiki/Installing/Source
Core:
python >= 2.5
boost >= 1.34.1
openssl
zlib
twisted
twisted-web
pyopenssl
simplejson (if python < 2.6)
setuptools
gettext
pyxdg
geoip-database (optional)
Gtk: See: DEPENDS for a full list of dependencies.
python-notify (libnotify python wrapper)
pygame
pygtk >= 2.12
librsvg
xdg-utils
chardet
Web:
mako
First, make sure you have the proper build dependencies installed. On a normal First, make sure you have the proper build dependencies installed. On a normal
Debian or Ubuntu system: Debian or Ubuntu system:
@ -78,7 +54,6 @@ Once you have the needed libraries installed, build and install by running:
$ python setup.py build $ python setup.py build
$ sudo python setup.py install $ sudo python setup.py install
========================== ==========================
FAQ FAQ
========================== ==========================
@ -88,9 +63,9 @@ How to start the various user-interfaces
Gtk: Gtk:
deluge --ui gtk deluge --ui gtk
Console: Console:
deluge --ui null deluge-console
Web: Web:
deluge --ui web deluge-web
Go to http://localhost:8112/ default-password = "deluge" Go to http://localhost:8112/ default-password = "deluge"
I started "deluge" but i don't see the gtk-ui I started "deluge" but i don't see the gtk-ui
@ -101,21 +76,22 @@ Why is deluge still listed in my system tray even after I close it ?
You closed the gtk user-interface but you did not close the daemon. Choose "Quit & Shutdown Daemon" to close both Daemon and gtk-ui. You closed the gtk user-interface but you did not close the daemon. Choose "Quit & Shutdown Daemon" to close both Daemon and gtk-ui.
How do I start the daemon ? How do I start the daemon?
deluged deluged
How do I start the daemon with logging to console ? How do I start the daemon with logging to console?
deluged -d deluged -d -L <log level>
I can't connect to the daemon from another machine I can't connect to the daemon from another machine/
* Configure the daemon to allow remote connections * Configure the daemon to allow remote connections
* Add a user to the auth file located in the config folder: ~/.config/deluge/auth
* Restart the daemon. * Restart the daemon.
Note: do not do this on a public ip , use the webui for unsecure networks.
I upgraded from 0.5 and plugin x is missing I upgraded from 0.5 and plugin x is missing
1.0 is a rewrite, all old 0.5 plugins have to be rewritten. 1.0 is a rewrite, all old 0.5 plugins have to be rewritten.
For the full FAQ see: http://dev.deluge-torrent.org/wiki/Faq