From 7fa1166baae84c5a2f385ff38972de2a5ab80200 Mon Sep 17 00:00:00 2001 From: Bryant Eadon Date: Sun, 31 Aug 2025 22:47:11 -0700 Subject: [PATCH] README combined Combined README files to reduce clutter. However, the build instructions are incomplete ... I've started by modifying these so a build will complete using the instructions once I get a closer look at libtorrent ... additions welcome. --- README | 41 ---------------------- README.md | 103 ++++++++++++++++++++++++++++++++++++++++-------------- 2 files changed, 77 insertions(+), 67 deletions(-) delete mode 100644 README diff --git a/README b/README deleted file mode 100644 index 836ab808..00000000 --- a/README +++ /dev/null @@ -1,41 +0,0 @@ -BUILDING - - Run "aclocal -I scripts && autoconf -i && autoheader && automake --add-missing" -to generate the configure scripts if necessary. The man page "doc/rtorrent.1" -must be generated with "docbook2man rtorrent.1.xml" if it is missing. - - Note that rtorrent follows the development of libtorrent closely, and -thus the versions must be in sync. This should not be nessesary in the -future, when the library API stabilizes. - -USAGE - - See the man page or website for instructions. - -LICENSE - - GNU GPL, see COPYING. "libtorrent/src/utils/sha_fast.{cc,h}" is -originally from the Mozilla NSS and is under a triple license; MPL, -LGPL and GPL. An exception to non-NSS code has been added for linking -to OpenSSL as requested by Debian, though the author considers that -library to be part of the Operative System and thus linking is allowed -according to the GPL. - - Use whatever fits your purpose, the code required to compile with -Mozilla's NSS implementation of SHA1 has been retained and can be -compiled if the user wishes to avoid using OpenSSL. - -DEPENDENCIES - - libcurl >= 7.12.0 - ncurses - -CONTACT - - Jari Sundell - - Skomakerveien 33 - 3185 Skoppum, NORWAY - - Send bug reports, suggestions and patches to - or to the mailinglist. diff --git a/README.md b/README.md index 39f6080b..f22cdaa3 100644 --- a/README.md +++ b/README.md @@ -3,37 +3,88 @@ RTorrent BitTorrent Client ======== -Introduction ------------- +# Introduction +A ncurses-based command line torrent client for high performance. To learn how to use rTorrent visit the [Wiki](https://github.com/rakshasa/rtorrent/wiki). -Stable ------- +Download the [latest stable release](https://github.com/rakshasa/rtorrent/releases/latest) - * [0.15.6](https://github.com/rakshasa/rtorrent/releases/tag/v0.15.6) +## Related Projects +* [https://github.com/rakshasa/rbedit](https://github.com/rakshasa/rbedit): A dependency-free bencode editor. -Unstable ------- - - * [https://github.com/rakshasa/rtorrent-archive/raw/master/libtorrent-0.14.0.tar.gz](https://github.com/rakshasa/rtorrent-archive/raw/master/libtorrent-0.14.0.tar.gz) - * [https://github.com/rakshasa/rtorrent-archive/raw/master/rtorrent-0.10.0.tar.gz](https://github.com/rakshasa/rtorrent-archive/raw/master/rtorrent-0.10.0.tar.gz) - -Related Projects ----------------- - - * [https://github.com/rakshasa/rbedit](https://github.com/rakshasa/rbedit): A dependency-free bencode editor. - -Donate to rTorrent development ------------------------------- - - * [Paypal](https://paypal.me/jarisundellno) - * [Patreon](https://www.patreon.com/rtorrent) - * [SubscribeStar](https://www.subscribestar.com/rtorrent) - * Bitcoin: 1MpmXm5AHtdBoDaLZstJw8nupJJaeKu8V8 - * Ethereum: 0x9AB1e3C3d8a875e870f161b3e9287Db0E6DAfF78 - * Litecoin: LdyaVR67LBnTf6mAT4QJnjSG2Zk67qxmfQ - * Cardano: addr1qytaslmqmk6dspltw06sp0zf83dh09u79j49ceh5y26zdcccgq4ph7nmx6kgmzeldauj43254ey97f3x4xw49d86aguqwfhlte +## Donate to rTorrent development +* [Paypal](https://paypal.me/jarisundellno) +* [Patreon](https://www.patreon.com/rtorrent) +* [SubscribeStar](https://www.subscribestar.com/rtorrent) +* Bitcoin: 1MpmXm5AHtdBoDaLZstJw8nupJJaeKu8V8 +* Ethereum: 0x9AB1e3C3d8a875e870f161b3e9287Db0E6DAfF78 +* Litecoin: LdyaVR67LBnTf6mAT4QJnjSG2Zk67qxmfQ +* Cardano: addr1qytaslmqmk6dspltw06sp0zf83dh09u79j49ceh5y26zdcccgq4ph7nmx6kgmzeldauj43254ey97f3x4xw49d86aguqwfhlte Help keep rTorrent development going by donating to its creator. + + +## BUILDING + +Jump into the github cloned directory +``` +cd rtorrent +``` + +### Install build dependencies +Example, Ubuntu +``` +sudo apt install libncurses-dev +``` + +Generate configure scripts: +``` +libtoolize && aclocal -I scripts && autoconf -i && autoheader && automake --add-missing" +``` + +Optionally, generate man pages: +``` +docbook2man rtorrent.1.xml +``` +man pages output to "doc/rtorrent.1" + +rtorrent follows the development of [libtorrent](https://libtorrent.org/) closely, and thus the versions must be in sync. This should not be nessesary in the future, when the library API stabilizes. + +## USAGE + +Refer to User Guide: https://github.com/rakshasa/rtorrent/wiki/User-Guide + +## LICENSE + +GNU GPL, see COPYING. "libtorrent/src/utils/sha_fast.{cc,h}" is +originally from the Mozilla NSS and is under a triple license; MPL, +LGPL and GPL. An exception to non-NSS code has been added for linking to OpenSSL as requested by Debian, though the author considers that library to be part of the Operative System and thus linking is allowed according to the GPL. + +Use whatever fits your purpose, the code required to compile with +Mozilla's NSS implementation of SHA1 has been retained and can be +compiled if the user wishes to avoid using OpenSSL. + +## DEPENDENCIES + +* libcurl >= 7.12.0 +* libtorrent >= 0.15.4 +* ncurses + +## BUILD DEPENDENCIES + +* libtoolize +* aclocal +* autoconf +* autoheader +* automake + +## CONTACT + +Jari Sundell +Skomakerveien 33 +3185 Skoppum, NORWAY + +Send bug reports, suggestions and patches to + or to the github issues list. \ No newline at end of file