minimal.c: add comment explaining the example

mypaint · Feb 23, 2020 · e74285d · e74285d
1 parent 80ff026
commit e74285d
Showing 1 changed file with 12 additions and 0 deletions.
diff --git a/examples/minimal.c b/examples/minimal.c
@@ -1,6 +1,18 @@
 #include "libmypaint.c"
 #include "mypaint-fixed-tiled-surface.h"
 
+/*
+
+This example draws a rectangle on a fixed surface, using the default brush.
+It only uses pre-v1.5.0 interfaces/structures.
+
+Compiling and running it will produce a file called "output.ppm".
+Open it in a compatible image viewer to see the result.
+
+The ppm format is _very_ space-inefficient, so only use low resolutions.
+
+*/
+
 void
 stroke_to(MyPaintBrush *brush, MyPaintSurface *surf, float x, float y)
 {