summaryrefslogtreecommitdiff
path: root/meme/README
diff options
context:
space:
mode:
authorWerner Almesberger <werner@almesberger.net>2016-02-14 03:54:57 (GMT)
committerWerner Almesberger <werner@almesberger.net>2016-02-14 03:55:32 (GMT)
commitd5afcf56635da6a906dc7343fed6576720b809ba (patch)
tree7bf699aadec0e766347b175f8dd3510c10c82293 /meme/README
parent72e6384adec350a300e7c508ee027f3ec8b5857c (diff)
downloadmisc-d5afcf56635da6a906dc7343fed6576720b809ba.zip
misc-d5afcf56635da6a906dc7343fed6576720b809ba.tar.gz
misc-d5afcf56635da6a906dc7343fed6576720b809ba.tar.bz2
meme/: add marker system (for documentation); option -m marker.gp to add markers
Diffstat (limited to 'meme/README')
-rw-r--r--meme/README17
1 files changed, 16 insertions, 1 deletions
diff --git a/meme/README b/meme/README
index a157389..81e6fa8 100644
--- a/meme/README
+++ b/meme/README
@@ -4,7 +4,8 @@ Mesh measurement utility
Usage:
-meme [-d dump.bmp] [-l logfile] [-o overlay.gp ...] <path-to-STL-file>
+meme [-d dump.bmp] [-l logfile] [-m marker.gp] [-o overlay.gp ...]
+ <path-to-STL-file>
meme -s slice.gp [-n] <path-to-STL-file>
@@ -99,6 +100,20 @@ selected with the numeric keys, starting with 1.
To better visualize overlays, the mesh can be toggled by pressing M.
+Marker
+------
+
+Makers are similar to overlays and are used to indicate measurements or
+to mark features in the mesh. Markers are read from the file specified
+with the -m option.
+
+A marker only consisting of text is defined with the line
+x y text
+
+A marker indicating a measurement between points A and B is defined with
+ax ay bx by text
+
+
Slicing
-------