Macro assistance part 1 - macro directive

[subdirmk.git] / README

diff --git a/README b/README
index d750cb8e6daa40c7a6baf84f95bcdf6e699cd402..130a1c7fbfc085dc9d2b5b8cf65a7d1b7f9c506b 100644 (file)
--- a/README
+++ b/README
@@ -331,6 +331,15 @@ Dollar doubling and macro assistance
 &$-            Stops dollar-doubling
        Both are idempotent and local to the file or context.
 
+Sometimes we will show $'s being doubled inside another construct.
+This means the content of the construct is $-doubled: $-doubling is
+locally enabled, and restored afterwards.
+
+&:macro NAME   =>      define NAME
+STUFF $ THINGS ..      STUFF $$ THINGS
+&:endm         ..      endef
+       NAME is processed for &
+
 While dollar-doubling:
 - - - - - - - - - - -