andreil/klipper
1
0
Fork 0
mirror of https://github.com/andreili/klipper.git synced 2025-08-23 19:34:06 +02:00
Code Issues Packages Projects Releases Wiki Activity

docs: Add a new Config_Changes.md document

Browse Source 
Add a document to track non-backwards compatible changes to the
printer config file.

Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
This commit is contained in:
Kevin O'Connor 2018-12-27 18:57:17 -05:00 committed by KevinOConnor
parent dc70a7c355
commit f2f54290e8
3 changed files with 18 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
docs/Config_Changes.md Normal file
View File

@ -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

4
docs/FAQ.md
View File

@ -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.

7
docs/Overview.md
View File

@ -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
=======================