aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md19
1 files changed, 19 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..4d1f057
--- /dev/null
+++ b/README.md
@@ -0,0 +1,19 @@
+## Images
+
+## Storing images
+
+Any image files (.png, .jpg, .gif, ...) MUST be stored in a separate branch. By
+default, those filetypes are ignored in this git repository, and must be added
+with `git add -f "${file}"`.
+
+### Generating images
+
+All images in the *out* or the *intermediate* directory must be processed with
+the following command:
+
+```
+convert "${in}" -resize 600x -ordered-dither 3x3 -colorspace gray "${out}"
+convert "${in}" -resize 600x -ordered-dither 3x3 -colors 16 "${out}"
+```
+
+- The use of `-colors 16` is encouraged for colored pictures.
remember that computers suck.