Add README file for quickprint settings

diff --git a/resources/quickprint/README b/resources/quickprint/README
new file mode 100644 (file)
index 0000000..349179e
--- /dev/null
+++ b/resources/quickprint/README
@@ -0,0 +1,34 @@
+Global print profiles are defined here. The format is :
+option_*.ini
+Material/profile.ini
+Material/option_*.ini
+Material/Quality/profile.ini
+
+All options must have 'option_' as prefix in their filename, and any subdirectory with a profile.ini file in it will be considered a material. In that material directory, any option files will be specific to that material and any subdirectory with a profile.ini file will be considered material quality (high quality, low quality, high strength, etc..).
+
+These global options and profiles will apply to all machines. For a machine specific quickprint settings, you need a directory with the machine_type as name and then the same format of files as above.
+Those new machine specific materials and options will only override global materials and options if they are similarly named, so it can be used to add a single material for a machine without duplicating all of the global options and materials. In order to override a material or an option, the directory name (or filename for options) must be match.
+
+For example :
+option_support.ini
+option_brim.ini
+ABS/profile.ini
+ABS/Low/profile.ini
+ABS/High/profile.ini
+my_machine_type/PLA/profile.ini
+my_machine_type/PLA/Normal/profile.ini
+
+This would cause 'my_machine_type' typed machines to have both ABS (with Low and High quality) and PLA (with Normal quality only) materials, as well as support and brim options, while every other machine will only get the ABS material with both optins.
+If the machine needs to override the ABS material, you can simply add a file :
+my_machine_type/ABS/profile.ini
+to override the ABS setting, where you can either control the content of the profile.ini, or add new options, or override global options for that specific material, or add new or override existing quality settings for ABS.
+
+The profile.ini file can contain 3 sections : [info], [profile] and [alterations] in which the [profile] and [alterations] sections contain respectively profile and alteration settings for printing, while the [info] section can contain the following keys :
+name = string -> The name of the profile to show in the UI
+disabled = true/false -> Disables this profile. Can be used to override a quality or material and disable it entirely. Default is False
+always_visible = true/false -> If set to True and the profile.ini belongs to the single quality of a material, or to the single material of a machine, it will allow the quality or material to always be visible in the UI. Otherwise, the material or quality section will be hidden from the UI. Default is True
+order = int -> The order to show this material or quality in the UI. Default is 999
+
+Profile options are applied in the following order : Material -> Quality -> Options. This allows you to group common settings for materials or to have options override everything else.
+
+The quickprint profiles are searched for in the ~/.Cura/quickprint directory first, allowing users to override their machines quickprint settings.
\ No newline at end of file