diff --git a/modules/doc/users.rst b/modules/doc/users.rst new file mode 100644 index 0000000000000000000000000000000000000000..a24b4aad076970cf8a64abc9316f88479ce6459e --- /dev/null +++ b/modules/doc/users.rst @@ -0,0 +1,20 @@ +Reporting a Problem +============================================================================== + + +When you run into a problem in OST or have question regarding it's usage, there +are a few things you can do to make the life of people helping you easier. If +you follow these simple steps, you will make sure, people understand what you are +after and will get a response more quickly. + + * Provide a short explanation of what you tried to accomplish, the result you + were expecting and what you got instead. A good example would be: **I tried + to read the attached PDB file. The file looks clean to me, but OST fails with + the following error: "invalid coordinate on line 4."** + * If possible, attach a small script that reproduces the problem. + * Include the relevant error message in your report + * Include the version of OpenStructure you are using + * Specify your operating system + * If you compiled OpenStructure manually, also include the version for Qt, + Eigen, Python and Boost. + diff --git a/modules/index.rst b/modules/index.rst index 81e6336e41c371a30b456e6eb3bdfcaaf8e1d02a..8e5b6dd427dcf1ae7c80fca0a0fb73e680d44aaf 100644 --- a/modules/index.rst +++ b/modules/index.rst @@ -7,6 +7,7 @@ OpenStructure documentation install intro + users base/generic base/base geom/geom @@ -96,14 +97,10 @@ Varia **Supported File Formats:** :doc:`structure formats<io/structure_formats>` | :doc:`sequence formats <io/sequence_formats>` | :doc:`image formats <io/image_formats>` - +**Users** :doc:`Reporting a problem <users>` Extending OpenStructure -------------------------------------------------------------------------------- **Howto:** :doc:`write new modules <newmodule>` | :doc:`integrate third-party tools <external>` | :doc:`logging <base/logging>` | :doc:`instructions for developers <contributing>` - - - -