diff --git a/docs/contributing.html b/docs/contributing.html new file mode 100644 index 000000000..69ddea6f5 --- /dev/null +++ b/docs/contributing.html @@ -0,0 +1,98 @@ + + + + + + +libtorrent manual + + + + + + + +
+
+
+ +
+ +
+

libtorrent manual

+ +++ + + + + + +
Author:Arvid Norberg, arvid@rasterbar.com
Version:0.15.0
+
+

Table of contents

+ +
+
+

contributing to libtorrent

+

There are several ways to contribute to libtorrent at various levels. Any help is +much appreciated. If you're interested in something libtorrent related that's not +enumerated on this page, please contact arvid@rasterbar.com or the mailing list.

+
    +
  1. +
    Testing
    +

    This is not just limited to finding bugs and ways to reproduce crashes, but also +sub-optimal behavior is certain scenarios and finding ways to reproduce those. Please +report any issue to the bug tracker at google code.

    +
    +
    +
  2. +
+
    +
  1. +
    Documentation
    +

    Finding typos or outdated sections in the documentation. Contributing documentation +based on your own experience and experimentation with the library or with BitTorrent +in general. Non-reference documentation is very much welcome as well, higher level +descriptions on how to configure libtorrent for various situations for instance.

    +
    +
    +
  2. +
  3. +
    Code
    +

    Contributing code for new features or bug-fixes is highly welcome. If you're interested +in adding a feature but not sure where to start, please contact the mailing list or +#libtorrent @ irc.freenode.net.

    +
    +
    +
  4. +
+
+
+ +
+ + +
+ + diff --git a/docs/contributing.rst b/docs/contributing.rst new file mode 100644 index 000000000..28a2d51c5 --- /dev/null +++ b/docs/contributing.rst @@ -0,0 +1,38 @@ +================= +libtorrent manual +================= + +:Author: Arvid Norberg, arvid@rasterbar.com +:Version: 0.15.0 + +.. contents:: Table of contents + :depth: 2 + :backlinks: none + +contributing to libtorrent +========================== + +There are several ways to contribute to libtorrent at various levels. Any help is +much appreciated. If you're interested in something libtorrent related that's not +enumerated on this page, please contact arvid@rasterbar.com or the `mailing list`_. + +.. _`mailing list`: http://lists.sourceforge.net/lists/listinfo/libtorrent-discuss + +1. Testing + This is not just limited to finding bugs and ways to reproduce crashes, but also + sub-optimal behavior is certain scenarios and finding ways to reproduce those. Please + report any issue to the bug tracker at `google code`_. + +.. _`google code`: http://code.google.com/p/libtorrent/issues/entry + +2. Documentation + Finding typos or outdated sections in the documentation. Contributing documentation + based on your own experience and experimentation with the library or with BitTorrent + in general. Non-reference documentation is very much welcome as well, higher level + descriptions on how to configure libtorrent for various situations for instance. + +3. Code + Contributing code for new features or bug-fixes is highly welcome. If you're interested + in adding a feature but not sure where to start, please contact the `mailing list`_ or + ``#libtorrent`` @ ``irc.freenode.net``. + diff --git a/docs/index.html b/docs/index.html index 79b38ddfc..9345b1518 100644 --- a/docs/index.html +++ b/docs/index.html @@ -34,6 +34,7 @@