codex-storage
/
deluge
mirror of https://github.com/codex-storage/deluge.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
deluge/README.md

64 lines
1.7 KiB
Markdown
Raw Permalink Normal View History

Cleanup and use markdown for source text files Use markdown to aid readability. Update the README and use it for the long_description in setup.py Add detailed requirement information to the DEPENDS files.
2018-10-16 12:15:07 +00:00
# Deluge BitTorrent Client
[![build-status]][travis-deluge] [![docs-status]][rtd-deluge]
[Packaging] Cleanup README for Pypi - Set a minimal Python version 3.5 and remove universal wheels. - Tidy up the README - Add Project URL for issues and docs.
2019-05-21 14:48:43 +00:00
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
a Console-UI. It uses [libtorrent][lt] at it's core to handle the BitTorrent
protocol.
Cleanup and use markdown for source text files Use markdown to aid readability. Update the README and use it for the long_description in setup.py Add detailed requirement information to the DEPENDS files.
2018-10-16 12:15:07 +00:00
[Packaging] Cleanup README for Pypi - Set a minimal Python version 3.5 and remove universal wheels. - Tidy up the README - Add Project URL for issues and docs.
2019-05-21 14:48:43 +00:00
## Install
Cleanup and use markdown for source text files Use markdown to aid readability. Update the README and use it for the long_description in setup.py Add detailed requirement information to the DEPENDS files.
2018-10-16 12:15:07 +00:00
[Packaging] Cleanup README for Pypi - Set a minimal Python version 3.5 and remove universal wheels. - Tidy up the README - Add Project URL for issues and docs.
2019-05-21 14:48:43 +00:00
From [PyPi](https://pypi.org/project/deluge):
pip install deluge
From source code:
Cleanup and use markdown for source text files Use markdown to aid readability. Update the README and use it for the long_description in setup.py Add detailed requirement information to the DEPENDS files.
2018-10-16 12:15:07 +00:00
python setup.py build
python setup.py install
[Packaging] Cleanup README for Pypi - Set a minimal Python version 3.5 and remove universal wheels. - Tidy up the README - Add Project URL for issues and docs.
2019-05-21 14:48:43 +00:00
See [DEPENDS](DEPENDS.md) and [Installing/Source] for dependency details.
Cleanup and use markdown for source text files Use markdown to aid readability. Update the README and use it for the long_description in setup.py Add detailed requirement information to the DEPENDS files.
2018-10-16 12:15:07 +00:00
## Usage
[Packaging] Cleanup README for Pypi - Set a minimal Python version 3.5 and remove universal wheels. - Tidy up the README - Add Project URL for issues and docs.
2019-05-21 14:48:43 +00:00
The various user-interfaces and Deluge daemon can be started with the following commands.
Use the `--help` option for further command options.
Cleanup and use markdown for source text files Use markdown to aid readability. Update the README and use it for the long_description in setup.py Add detailed requirement information to the DEPENDS files.
2018-10-16 12:15:07 +00:00
[Packaging] Cleanup README for Pypi - Set a minimal Python version 3.5 and remove universal wheels. - Tidy up the README - Add Project URL for issues and docs.
2019-05-21 14:48:43 +00:00
### Gtk UI
Cleanup and use markdown for source text files Use markdown to aid readability. Update the README and use it for the long_description in setup.py Add detailed requirement information to the DEPENDS files.
2018-10-16 12:15:07 +00:00
[Packaging] Cleanup README for Pypi - Set a minimal Python version 3.5 and remove universal wheels. - Tidy up the README - Add Project URL for issues and docs.
2019-05-21 14:48:43 +00:00
`deluge` or `deluge-gtk`
Cleanup and use markdown for source text files Use markdown to aid readability. Update the README and use it for the long_description in setup.py Add detailed requirement information to the DEPENDS files.
2018-10-16 12:15:07 +00:00
[Packaging] Cleanup README for Pypi - Set a minimal Python version 3.5 and remove universal wheels. - Tidy up the README - Add Project URL for issues and docs.
2019-05-21 14:48:43 +00:00
### Console UI
Cleanup and use markdown for source text files Use markdown to aid readability. Update the README and use it for the long_description in setup.py Add detailed requirement information to the DEPENDS files.
2018-10-16 12:15:07 +00:00
[Packaging] Cleanup README for Pypi - Set a minimal Python version 3.5 and remove universal wheels. - Tidy up the README - Add Project URL for issues and docs.
2019-05-21 14:48:43 +00:00
`deluge-console`
Cleanup and use markdown for source text files Use markdown to aid readability. Update the README and use it for the long_description in setup.py Add detailed requirement information to the DEPENDS files.
2018-10-16 12:15:07 +00:00
[Packaging] Cleanup README for Pypi - Set a minimal Python version 3.5 and remove universal wheels. - Tidy up the README - Add Project URL for issues and docs.
2019-05-21 14:48:43 +00:00
### Web UI
Cleanup and use markdown for source text files Use markdown to aid readability. Update the README and use it for the long_description in setup.py Add detailed requirement information to the DEPENDS files.
2018-10-16 12:15:07 +00:00
[Packaging] Cleanup README for Pypi - Set a minimal Python version 3.5 and remove universal wheels. - Tidy up the README - Add Project URL for issues and docs.
2019-05-21 14:48:43 +00:00
`deluge-web`
Cleanup and use markdown for source text files Use markdown to aid readability. Update the README and use it for the long_description in setup.py Add detailed requirement information to the DEPENDS files.
2018-10-16 12:15:07 +00:00
[Packaging] Cleanup README for Pypi - Set a minimal Python version 3.5 and remove universal wheels. - Tidy up the README - Add Project URL for issues and docs.
2019-05-21 14:48:43 +00:00
Open http://localhost:8112 with default password `deluge`.
Cleanup and use markdown for source text files Use markdown to aid readability. Update the README and use it for the long_description in setup.py Add detailed requirement information to the DEPENDS files.
2018-10-16 12:15:07 +00:00
[Packaging] Cleanup README for Pypi - Set a minimal Python version 3.5 and remove universal wheels. - Tidy up the README - Add Project URL for issues and docs.
2019-05-21 14:48:43 +00:00
### Daemon
Cleanup and use markdown for source text files Use markdown to aid readability. Update the README and use it for the long_description in setup.py Add detailed requirement information to the DEPENDS files.
2018-10-16 12:15:07 +00:00
[Packaging] Cleanup README for Pypi - Set a minimal Python version 3.5 and remove universal wheels. - Tidy up the README - Add Project URL for issues and docs.
2019-05-21 14:48:43 +00:00
`deluged`
Cleanup and use markdown for source text files Use markdown to aid readability. Update the README and use it for the long_description in setup.py Add detailed requirement information to the DEPENDS files.
2018-10-16 12:15:07 +00:00
[Packaging] Cleanup README for Pypi - Set a minimal Python version 3.5 and remove universal wheels. - Tidy up the README - Add Project URL for issues and docs.
2019-05-21 14:48:43 +00:00
See the [Thinclient guide] to connect to the daemon from another computer.
Cleanup and use markdown for source text files Use markdown to aid readability. Update the README and use it for the long_description in setup.py Add detailed requirement information to the DEPENDS files.
2018-10-16 12:15:07 +00:00
[Packaging] Cleanup README for Pypi - Set a minimal Python version 3.5 and remove universal wheels. - Tidy up the README - Add Project URL for issues and docs.
2019-05-21 14:48:43 +00:00
## Contact
Cleanup and use markdown for source text files Use markdown to aid readability. Update the README and use it for the long_description in setup.py Add detailed requirement information to the DEPENDS files.
2018-10-16 12:15:07 +00:00
- [Homepage](https://deluge-torrent.org)
[Packaging] Cleanup README for Pypi - Set a minimal Python version 3.5 and remove universal wheels. - Tidy up the README - Add Project URL for issues and docs.
2019-05-21 14:48:43 +00:00
- [User guide][user guide]
Cleanup and use markdown for source text files Use markdown to aid readability. Update the README and use it for the long_description in setup.py Add detailed requirement information to the DEPENDS files.
2018-10-16 12:15:07 +00:00
- [Forum](https://forum.deluge-torrent.org)
- [IRC Freenode #deluge](irc://irc.freenode.net/deluge)
[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"
[Packaging] Cleanup README for Pypi - Set a minimal Python version 3.5 and remove universal wheels. - Tidy up the README - Add Project URL for issues and docs.
2019-05-21 14:48:43 +00:00
[lt]: https://libtorrent.org