aboutsummaryrefslogtreecommitdiffstats
path: root/docs/Contact.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/Contact.md')
-rw-r--r--docs/Contact.md36
1 files changed, 36 insertions, 0 deletions
diff --git a/docs/Contact.md b/docs/Contact.md
new file mode 100644
index 00000000..a025f33b
--- /dev/null
+++ b/docs/Contact.md
@@ -0,0 +1,36 @@
+This page provides information on how to contact the Klipper
+developers.
+
+Bug reporting
+=============
+
+Bug reports are submitted through github issues. All bug reports must
+include the full /tmp/klippy.log log file from the session that
+produced the error. To acquire this log file, ssh into the computer
+running the klipper host software, and run:
+
+```
+gzip -k /tmp/klippy.log
+```
+
+Then scp the resulting `/tmp/klippy.log.gz` file from the host machine
+to your desktop. (If your desktop does not have scp installed, there
+are a number of free scp programs available - just do a web search for
+`windows scp` to find one.) Open a new issue at
+https://github.com/KevinOConnor/klipper/issues , attach the
+`klippy.log.gz` file to that issue, and provide a description of the
+problem.
+
+IRC
+===
+
+One may join the #klipper channel on freenode.net (
+irc://chat.freenode.net:6667 ).
+
+To communicate in this IRC channel one will need an IRC
+client. Configure it to connect to chat.freenode.net on port 6667 and
+join the #klipper channel (`/join #klipper`).
+
+If asking a question on IRC, be sure to ask the question and then stay
+connected to the channel to receive responses. Due to timezone
+differences, it may take several hours before receiving a response.