summaryrefslogtreecommitdiffstats
path: root/libraries/libtorrent2/README
diff options
context:
space:
mode:
Diffstat (limited to 'libraries/libtorrent2/README')
-rw-r--r--libraries/libtorrent2/README19
1 files changed, 19 insertions, 0 deletions
diff --git a/libraries/libtorrent2/README b/libraries/libtorrent2/README
new file mode 100644
index 0000000000..aa787bb2f5
--- /dev/null
+++ b/libraries/libtorrent2/README
@@ -0,0 +1,19 @@
+libtorrent is an open source C++ library implementing the BitTorrent
+protocol, along with most popular extensions, making it suitable for
+real world deployment. It is configurable to be able to fit both
+servers and embedded devices.
+
+The main goals of libtorrent are to be efficient and easy to use.
+
+libtorrent2 builds the 2.x branch of libtorrent (also referred to as
+libtorrent-rasterbar). As such, this package conflicts with
+libtorrent and libtorrent-rasterbar.
+
+If you would like to install examples, pass EXAMPLES=ON to the build
+script.
+
+If you would like to build the test suide, pass TESTS=ON to the
+build script.
+
+If you would like to build some extra tools, pass TOOLS=ON to the
+build script.