From 1b7623e17b16965023d34f8a85946c330ed18105 Mon Sep 17 00:00:00 2001
From: TLC123 <torleif.ceder@gmail.com>
Date: Mon, 23 Aug 2021 15:52:21 +0200
Subject: [PATCH] Update unionRoundMask-Doc.md

cleanup headers
---
 unionRoundMask-Doc.md | 66 +++++++++++++++++++++++++++++++------------
 1 file changed, 48 insertions(+), 18 deletions(-)

diff --git a/unionRoundMask-Doc.md b/unionRoundMask-Doc.md
index c646d66..2ce2b68 100644
--- a/unionRoundMask-Doc.md
+++ b/unionRoundMask-Doc.md
@@ -1,12 +1,33 @@
-#unionRoundMask
+## unionRoundMask
+### Union with round fillet at selected places.
+![unionround-doc-example](https://user-images.githubusercontent.com/10944617/130456818-c5fd43d1-e6df-4e88-8474-aed1a0c3ca31.png)
+
+
 module unionRoundMask(r=1, detail = 5 , q=70, epsilon = 1e-6, showMask = true) 
 
-Masks are a method to perform unionRound on selected only areas 
-and circumvents the limitation of common convex work area
-Mask are just common primitives that is used to mark out areas.
+Masks are a method to perform unionRound on selected only areas, 
+and circumvents the limitation of common convex work area.
 
-usage:
-unionRoundMask(r=1,detail=3,q=30)
+Mask are essentially just common primitives that is used to mark out areas.
+
+r:  
+   * approximate radius for fillet. Exact radius is dependant on crease angle.  
+   * detail: numbers of fillet segments. 1 is essensially  a chamfer/bevel.      
+   * Set low for faster preview. ( $preview?3:10 )
+
+q:  
+   * determine how detailed clad operations are.    
+   * Set low for faster preview. ( $preview?30:70 )
+
+epsilon:   
+   * For debugging, leave as is.
+
+showMask:  
+   * For debugging, try it.
+
+### usage:
+````
+unionRoundMask( r = 1 , detail = $preview ? 3 : 10 , q = $preview ? 30 : 70 )
 {
     yourObject1();
     yourObject2();
@@ -17,31 +38,40 @@ unionRoundMask(r=1,detail=3,q=30)
     //    ...
     //    ...
 }
+````
 
-#unionRound
+---
+## unionRound
 module unionRound(r=1, detail = 5 , q=70,  epsilon = 1e-6)
 
 Module unionRound is the underlying work module of unionRoundMask. 
 It can be used by it self, in some cases faster but more raw.
 
-usage:
-unionRoundMask(r=1,detail=3,q=30)
+### usage:
+````
+unionRoundMask( r = 1 , detail = $preview ? 3 : 10 , q= $preview ? 30 : 70 )
 {
     yourObject1();
     yourObject2();
 }
+````
 
+---
+## intersectionRound
+module intersectionRound(r, q=70,  epsilon = 1e-6,showOperands = true) 
 
-#intersectionRound
-module intersectionRound(r, q=70,  epsilon = 1e-6,showOperands = true) {
 Undocumented for now.
 
-//helpers
-module  clad(r,q=70) // speed is limited to convex operand
-module shell(r,q=70) // not in use
-module inset(r,q=20) // speed is limited to convex operand
+---
+## helpers
+module  clad(r,q=70) // speed is limited to convex operand  
+module shell(r,q=70) // not in use  
+module inset(r,q=20) // speed is limited to convex operand  
 
+---
 ## Citation        
-roundUnionMask Includes code based on examples from:
-    Kogan, Jonathan (2017) "A New Computationally Efficient Method for Spacing n Points on a Sphere," Rose-Hulman Undergraduate Mathematics Journal: Vol. 18 : Iss. 2 , Article 5.
-    Available at: [https://scholar.rose-hulman.edu/rhumj/vol18/iss2/5]
\ No newline at end of file
+roundUnionMask Includes code based on examples from:  
+    Kogan, Jonathan (2017)  
+    "A New Computationally Efficient Method for Spacing n Points on a Sphere,"  
+    Rose-Hulman Undergraduate Mathematics Journal: Vol. 18 : Iss. 2 , Article 5.  
+    Available at: [https://scholar.rose-hulman.edu/rhumj/vol18/iss2/5]