diff options
| -rw-r--r-- | docs/Config_Changes.md | 9 | ||||
| -rw-r--r-- | docs/FAQ.md | 4 | ||||
| -rw-r--r-- | docs/Overview.md | 7 |
3 files changed, 18 insertions, 2 deletions
diff --git a/docs/Config_Changes.md b/docs/Config_Changes.md new file mode 100644 index 00000000..598f47cf --- /dev/null +++ b/docs/Config_Changes.md @@ -0,0 +1,9 @@ +This document covers recent software changes to the config file that +are not backwards compatible. It is a good idea to review this +document when upgrading the Klipper software. + +All dates in this document are approximate. + +# Changes + +20181220: Klipper v0.7.0 released diff --git a/docs/FAQ.md b/docs/FAQ.md index f02ef1ce..a5827f16 100644 --- a/docs/FAQ.md +++ b/docs/FAQ.md @@ -424,3 +424,7 @@ follow the full upgrade steps outlined above. Note that the RESTART and FIRMWARE_RESTART g-code commands do not load new software - the above "sudo service klipper restart" and "make flash" commands are needed for a software change to take effect. + +When upgrading the software, be sure to check the +[config changes](Config_Changes.md) document for information on +software changes that may require updates to your printer.cfg file. diff --git a/docs/Overview.md b/docs/Overview.md index a781344d..ce69e513 100644 --- a/docs/Overview.md +++ b/docs/Overview.md @@ -25,8 +25,11 @@ some common questions. The [G-Codes](G-Codes.md) document lists currently supported run-time commands. The history of Klipper releases is available at -[releases](Releases.md). See [contact](Contact.md) for information on -bug reporting and general communication with the developers. +[releases](Releases.md). The [config changes](Config_Changes.md) +document describes recent software changes that may require users to +update their printer config file. See [contact](Contact.md) for +information on bug reporting and general communication with the +developers. Developer Documentation ======================= |