aboutsummaryrefslogtreecommitdiffstats
path: root/docs/Example_Configs.md
diff options
context:
space:
mode:
authorKevin O'Connor <kevin@koconnor.net>2021-04-13 21:14:46 -0400
committerKevin O'Connor <kevin@koconnor.net>2021-04-13 21:14:46 -0400
commit316b49c6bfb91683eedba70d2674b60091b09e7e (patch)
tree8be7e80ab6d34ac00d21bb85311b3112c1f8e324 /docs/Example_Configs.md
parentde8eb884b47458d6835e31d23fe15a4a9b70080c (diff)
downloadkutter-316b49c6bfb91683eedba70d2674b60091b09e7e.tar.gz
kutter-316b49c6bfb91683eedba70d2674b60091b09e7e.tar.xz
kutter-316b49c6bfb91683eedba70d2674b60091b09e7e.zip
docs: Note that attribution/history should be avoiding in Example_Configs.md
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
Diffstat (limited to 'docs/Example_Configs.md')
-rw-r--r--docs/Example_Configs.md4
1 files changed, 4 insertions, 0 deletions
diff --git a/docs/Example_Configs.md b/docs/Example_Configs.md
index c4a53314..c9994a47 100644
--- a/docs/Example_Configs.md
+++ b/docs/Example_Configs.md
@@ -84,6 +84,10 @@ finding and sharing config files.
value. For example, one should not specify `min_extrude_temp:
170` as that is already the default value.
7. Where possible, lines should not exceed 80 columns.
+ 8. Avoid adding attribution or revision messages to the config
+ files. (For example, avoid adding lines like "this file was
+ created by ...".) Place attribution and change history in the
+ git commit message.
7. Do not use any deprecated features in the example config file. The
`step_distance` and `pin_map` parameters are deprecated and should
not be in any example config file.