diff --git a/docs/_templates/navbar.html b/docs/_templates/navbar.html index 382d0c7..59fe6d8 100644 --- a/docs/_templates/navbar.html +++ b/docs/_templates/navbar.html @@ -50,6 +50,8 @@
  • Instaloader on GitHub
  • Star
  • + +
  • Donate (via Paypal)
  • diff --git a/docs/contributing.rst b/docs/contributing.rst index eb02fc4..a1a73eb 100644 --- a/docs/contributing.rst +++ b/docs/contributing.rst @@ -1,3 +1,5 @@ +.. _contributing: + Contributing to Instaloader =========================== @@ -23,7 +25,7 @@ following in mind: - Briefly **check whether the bug has already been reported**. If you find an issue reporting the same bug you encountered, comment there rather than - opening a new issue. However, if unsure, it is advised to create a new issue. + opening a new issue. However, if unsure, please create a new issue. - State **how the bug can be reproduced**, i.e. how Instaloader was invoked when the problem occured (of course, you may anonymize profile names etc.). @@ -47,13 +49,13 @@ few things to consider: you forked from the most recent branch. - We use `Pylint `__ for error and syntax checking of - ``instaloader.py``. The file ``.travis.yml`` in the project's root directory + the source. The file ``.travis.yml`` in the project's root directory shows how it is invoked. Note that sometimes it might be better to disable a warning rather than adapting the code to Pylint's desires. - The documentation source is located in the ``docs`` folder. The file ``cli-options.rst`` is merely an RST-formatted copy of ``ìnstaloader --help`` - output, of which the source is near the bottom of ``instaloader.py``. + output, of which the source is in ``instaloader/__main__.py``. - Feel free to contact us, even if you "only" have Proof-of-Concepts or not-fully integrated changes. They already might be an advance for the @@ -81,3 +83,21 @@ Please consider the following: - **Be patient**. Naturally, bugs and pull requests have a higher priority than feature suggestions. Keep in mind that this is a free software project, and unfortunately we only have limited time to work on it. + +Donations +--------- + +.. donations-start + +It is a pleasure for us to share our Instaloader to the world, and we are proud +to have attracted such an active and motivating community, with so many users +who share their suggestions and ideas with us. Buying a community-sponsored beer +or coffee from time to time is very likely to further raise our passion for the +development of Instaloader. + +We have a PayPal.Me link for donations: `PayPal.me/aandergr +`__ + +.. donations-end + +.. (Discussion in :issue:`130`) diff --git a/docs/index.rst b/docs/index.rst index 6549152..5f0987f 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -70,10 +70,23 @@ Useful Links - `Issue Tracker / Bug Tracker `__ - `Version History `__ +Disclaimer +---------- + .. include:: ../README.rst :start-after: disclaimer-start :end-before: disclaimer-end +Contributing +------------ + +As an open source project, Instaloader heavily depends on the contributions from +its community. See :ref:`contributing` for how you may help Instaloader to +become an even greater tool. + +.. include:: contributing.rst + :start-after: donations-start + :end-before: donations-end .. * :ref:`genindex`