deluge/README.rst

=========================
 Deluge BitTorrent Client
=========================

|build-status| |docs|

Homepage: http://deluge-torrent.org

Authors:
    Andrew Resch
    Damien Churchill

For contributors and past developers see:
    AUTHORS

==========================
Installation Instructions:
==========================

For detailed instructions see: http://dev.deluge-torrent.org/wiki/Installing/Source

Ensure build dependencies are installed, see DEPENDS for a full listing.

Build and install by running::

    $ python setup.py build
    $ sudo python setup.py install

================
Contact/Support:
================

:Forum: http://forum.deluge-torrent.org
:IRC Channel: #deluge on irc.freenode.net

===
FAQ
===

For the full FAQ see: http://dev.deluge-torrent.org/wiki/Faq

How to start the various user-interfaces:
    Gtk::

        deluge or deluge-gtk

    Console::

        deluge-console

    Web::

        deluge-web
        Go to http://localhost:8112/ default-password = "deluge"

How do I start the daemon?:
    deluged

I can't connect to the daemon from another machine:
    See: http://dev.deluge-torrent.org/wiki/UserGuide/ThinClient


.. |build-status| image:: https://travis-ci.org/deluge-torrent/deluge.svg
    :target: https://travis-ci.org/deluge-torrent/deluge

.. |docs| image:: https://readthedocs.org/projects/deluge/badge/?version=develop
    :target: https://readthedocs.org/projects/deluge/?badge=develop
    :alt: Documentation Status
Rename README to README.rst Update rst formatting in readme Add RTD and Travis badges to README 2014-09-21 18:13:26 +00:00			`=========================`
include faq 2008-09-14 19:02:06 +00:00			`Deluge BitTorrent Client`
Rename README to README.rst Update rst formatting in readme Add RTD and Travis badges to README 2014-09-21 18:13:26 +00:00			`=========================`

			`\|build-status\| \|docs\|`
include faq 2008-09-14 19:02:06 +00:00
Update README and add a DEPENDS file that lists the dependencies 2009-07-15 02:50:26 +00:00			`Homepage: http://deluge-torrent.org`

include faq 2008-09-14 19:02:06 +00:00			`Authors:`
			`Andrew Resch`
Update README to include current deps 2009-02-11 00:55:30 +00:00			`Damien Churchill`
include faq 2008-09-14 19:02:06 +00:00
Update pre-commit config The prettier hook was missing a trailing slash so omitting css files. Add a trailing space fix hook and fix issues. 2018-10-08 13:22:49 +00:00			`For contributors and past developers see:`
Update README file 2011-12-15 15:30:41 +00:00			`AUTHORS`
include faq 2008-09-14 19:02:06 +00:00
			`==========================`
			`Installation Instructions:`
			`==========================`

Update README file 2011-12-15 15:30:41 +00:00			`For detailed instructions see: http://dev.deluge-torrent.org/wiki/Installing/Source`
Update README to include current deps 2009-02-11 00:55:30 +00:00
Update README file 2011-12-15 15:30:41 +00:00			`Ensure build dependencies are installed, see DEPENDS for a full listing.`
include faq 2008-09-14 19:02:06 +00:00
Rename README to README.rst Update rst formatting in readme Add RTD and Travis badges to README 2014-09-21 18:13:26 +00:00			`Build and install by running::`
include faq 2008-09-14 19:02:06 +00:00
Update README file 2011-12-15 15:30:41 +00:00			`$ python setup.py build`
			`$ sudo python setup.py install`
include faq 2008-09-14 19:02:06 +00:00
Rename README to README.rst Update rst formatting in readme Add RTD and Travis badges to README 2014-09-21 18:13:26 +00:00			`================`
Update README file 2011-12-15 15:30:41 +00:00			`Contact/Support:`
Rename README to README.rst Update rst formatting in readme Add RTD and Travis badges to README 2014-09-21 18:13:26 +00:00			`================`
include faq 2008-09-14 19:02:06 +00:00
Rename README to README.rst Update rst formatting in readme Add RTD and Travis badges to README 2014-09-21 18:13:26 +00:00			`:Forum: http://forum.deluge-torrent.org`
			`:IRC Channel: #deluge on irc.freenode.net`
include faq 2008-09-14 19:02:06 +00:00
Rename README to README.rst Update rst formatting in readme Add RTD and Travis badges to README 2014-09-21 18:13:26 +00:00			`===`
include faq 2008-09-14 19:02:06 +00:00			`FAQ`
Rename README to README.rst Update rst formatting in readme Add RTD and Travis badges to README 2014-09-21 18:13:26 +00:00			`===`
include faq 2008-09-14 19:02:06 +00:00
Update README file 2011-12-15 15:30:41 +00:00			`For the full FAQ see: http://dev.deluge-torrent.org/wiki/Faq`

Rename README to README.rst Update rst formatting in readme Add RTD and Travis badges to README 2014-09-21 18:13:26 +00:00			`How to start the various user-interfaces:`
			`Gtk::`
include faq 2008-09-14 19:02:06 +00:00
Update README file 2011-12-15 15:30:41 +00:00			`deluge or deluge-gtk`
Rename README to README.rst Update rst formatting in readme Add RTD and Travis badges to README 2014-09-21 18:13:26 +00:00
			`Console::`

Update README and add a DEPENDS file that lists the dependencies 2009-07-15 02:50:26 +00:00			`deluge-console`
Rename README to README.rst Update rst formatting in readme Add RTD and Travis badges to README 2014-09-21 18:13:26 +00:00
			`Web::`

Update README and add a DEPENDS file that lists the dependencies 2009-07-15 02:50:26 +00:00			`deluge-web`
include faq 2008-09-14 19:02:06 +00:00			`Go to http://localhost:8112/ default-password = "deluge"`

Rename README to README.rst Update rst formatting in readme Add RTD and Travis badges to README 2014-09-21 18:13:26 +00:00			`How do I start the daemon?:`
include faq 2008-09-14 19:02:06 +00:00			`deluged`

Rename README to README.rst Update rst formatting in readme Add RTD and Travis badges to README 2014-09-21 18:13:26 +00:00			`I can't connect to the daemon from another machine:`
Update README file 2011-12-15 15:30:41 +00:00			`See: http://dev.deluge-torrent.org/wiki/UserGuide/ThinClient`
include faq 2008-09-14 19:02:06 +00:00
Rename README to README.rst Update rst formatting in readme Add RTD and Travis badges to README 2014-09-21 18:13:26 +00:00
			`.. \|build-status\| image:: https://travis-ci.org/deluge-torrent/deluge.svg`
			`:target: https://travis-ci.org/deluge-torrent/deluge`

Fix RTD badge in readme 2014-09-22 23:18:34 +00:00			`.. \|docs\| image:: https://readthedocs.org/projects/deluge/badge/?version=develop`
			`:target: https://readthedocs.org/projects/deluge/?badge=develop`
[Lint] Exclude js and css from EOF fixer - When running pre-commit on all files it is picking up minified js and css files. Since prettier will format correctly the source files ignore them in end-of-file fixer. - The template files in web docs can be ignored too. - Removed the unneeded `pre-commit-hooks` dependency as pre-commit resolves that itself. - Include files fixed by pre-commit. 2018-10-05 14:24:36 +00:00			`:alt: Documentation Status`