From a7a6f1053fbf12078ec7848a12a14507a44ba256 Mon Sep 17 00:00:00 2001 From: Anton Akhmerov <anton.akhmerov@gmail.com> Date: Sun, 8 Sep 2013 10:09:33 +0200 Subject: [PATCH] fill in references to mailing list and the paper --- CONTRIBUTE | 28 +++++++++++++++++----------- doc/source/tutorial/introduction.rst | 5 ++--- 2 files changed, 19 insertions(+), 14 deletions(-) diff --git a/CONTRIBUTE b/CONTRIBUTE index 5677a69..415760d 100644 --- a/CONTRIBUTE +++ b/CONTRIBUTE @@ -7,27 +7,33 @@ framework for implementing different physics-related algorithms using a common set of concepts and, if possible, a shared interface. We have designed it leaving room for growth, and plan to keep extending it. -External contributions to Kwant are highly welcome. You can help to advance the -project not only by writing code, but also by reporting bugs, and -fixing/improving the documentation. A mailing list TODO: add link (also -usable through a web interface (TODO: add link) ) is available for discussions. +External contributions to Kwant are highly welcome. You can help to advance +the project not only by writing code, but also by reporting bugs, and +fixing/improving the documentation. A `mailing list +<http://kwant-project.org/community.html>`_ is available for discussions. If you have some code that works well with Kwant, or extends it in some useful way, please consider sharing it. Any external contribution will be clearly -marked as such, and relevant papers will be added to the list of :doc:`suggested -acknowledgements <citing>`. The complete development history is available -through a `web interface <http://git.kwant-project.org/kwant>`_. +marked as such, and relevant papers will be added to the list of +:doc:`suggested acknowledgements <citing>`. The complete development history +is also made available through a `web interface +<http://git.kwant-project.org/kwant>`_. If you plan to contribute, it is best +to coordinate with us in advance either through the `mailing list +<http://kwant-project.org/community.html>`__, or directly by `email +<mailto:authors@kwant-project.org>`_ for matters that you prefer to not discuss +publicly. Reporiting bugs --------------- If you encounter a problem with Kwant, first try to reproduce it with as simple -a system as possible. Double-check with the documentation that what you observe -is actually a bug in Kwant. If you think it is, please check whether the problem -is already known by searching the mailing list. (TODO: tell how). +a system as possible. Double-check with the documentation that what you +observe is actually a bug in Kwant. If you think it is, please check whether +the problem is already known by searching the `mailing list +<http://kwant-project.org/community.html>`__. If the problem is not known yet, please email a bug report to the `Kwant mailing -list <mailto:kwant-discuss@kwant-project.org>`_. A report should contain: +list <http://kwant-project.org/community.html>`__. A report should contain: * The versions of software you are using (Kwant, Python, operating system, etc.) diff --git a/doc/source/tutorial/introduction.rst b/doc/source/tutorial/introduction.rst index d46cea1..3f750d2 100644 --- a/doc/source/tutorial/introduction.rst +++ b/doc/source/tutorial/introduction.rst @@ -7,9 +7,8 @@ commented extensively. In addition, you will find notes about more subtle, technical details at the end of each example. At first reading, these notes may be safely skipped. -A scientific article about Kwant is available as well: - -TO-BE-FILLED-IN +A scientific article about Kwant is available as well, see `Kwant +website <http://kwant-project.org/citing.html>`_. The article introduces Kwant with a somewhat different focus than the tutorial and it is the authors' intention that both texts complement each other. While -- GitLab