diff options
| author | Kevin O'Connor <kevin@koconnor.net> | 2017-10-10 12:39:06 -0400 |
|---|---|---|
| committer | Kevin O'Connor <kevin@koconnor.net> | 2017-10-10 12:43:44 -0400 |
| commit | ce7cc798dcf4b51671e8cf3c8e7454b9e1d5c894 (patch) | |
| tree | 466031deff37721f2dde3e147cd144dac8cd1d91 | |
| parent | 0ec7eda11b0f83f60bec37da472a3795c22d0e0d (diff) | |
| download | kutter-ce7cc798dcf4b51671e8cf3c8e7454b9e1d5c894.tar.gz kutter-ce7cc798dcf4b51671e8cf3c8e7454b9e1d5c894.tar.xz kutter-ce7cc798dcf4b51671e8cf3c8e7454b9e1d5c894.zip | |
docs: Add Contact.md file with developer contact information
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
| -rw-r--r-- | docs/Contact.md | 36 | ||||
| -rw-r--r-- | docs/Installation.md | 5 | ||||
| -rw-r--r-- | docs/Overview.md | 3 |
3 files changed, 43 insertions, 1 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. diff --git a/docs/Installation.md b/docs/Installation.md index 99f3f571..d1c40a24 100644 --- a/docs/Installation.md +++ b/docs/Installation.md @@ -119,3 +119,8 @@ provides more detailed information. In addition to common g-code commands, Klipper supports a few extended commands - "status" and "restart" are examples of these commands. Use the "help" command to get a list of other extended commands. + +Contacting the developers +========================= + +See the [contact page](Contact.md) to ask questions or report a bug. diff --git a/docs/Overview.md b/docs/Overview.md index 759805ac..38ed9c26 100644 --- a/docs/Overview.md +++ b/docs/Overview.md @@ -16,7 +16,8 @@ The [kinematics](Kinematics.md) document provides some technical details on how Klipper implements motion. The history of Klipper releases is available at -[releases](Releases.md). +[releases](Releases.md). See [contact](Contact.md) for information on +bug reporting and general communication with the developers. Developer Documentation ======================= |