diff --git a/README.md b/README.md index fe60f6d..e212237 100644 --- a/README.md +++ b/README.md @@ -18,27 +18,27 @@ For purposes of the BOSL library, the following terms apply: ## Examples A lot of the features of this library are to allow shorter, easier-to-read, intent-based coding. For example: -`BOSL/transforms.scad` Examples | Raw OpenSCAD Equivalent --------------------------------- | ------------------------------- -`up(5)` | `translate([0,0,5])` -`xrot(30, cp=[0, 10, 20])` | `translate([0,10,20]) rotate([30,0,0]) translate([0,-10,-20])` -`xspread(20, n=3)` | `for (dx=[-20,0,20]) translate([dx,0,0])` -`zring(n=6, r=20)` | `for (zr=[0:5]) rotate([0,0,zr*60]) translate([20,0,0])` -`skew_xy(xa=30,ya=45)` | `multmatrix([[1, 0, tan(30), 0], [0, 1, tan(45), 0], [0, 0, 1, 0], [0, 0, 0, 1]])` +`BOSL/transforms.scad` Examples | Raw OpenSCAD Equivalent +------------------------------- | ------------------------------- +`up(5)` | `translate([0,0,5])` +`xrot(30,cp=[0, 10, 20])` | `translate([0,10,20]) rotate([30,0,0]) translate([0,-10,-20])` +`xspread(20,n=3)` | `for (dx=[-20,0,20]) translate([dx,0,0])` +`zring(n=6,r=20)` | `for (zr=[0:5]) rotate([0,0,zr*60]) translate([20,0,0])` +`skew_xy(xa=30,ya=45)` | `multmatrix([[1, 0, tan(30), 0], [0, 1, tan(45), 0], [0, 0, 1, 0], [0, 0, 0, 1]])` -`BOSL/shapes.scad` Examples | Raw OpenSCAD Equivalent ------------------------------------- | ------------------------------- -`upcube([10,20,30]);` | `translate([0,0,15]) cube([10,20,30], center=true);` -`rcube([20,20,30], r=5, $fn=32);` | `minkowski() {cube([10,10,20], center=true); sphere(r=5, $fn=32);}` -`trapezoid([30,40], [20,30], h=10);` | `hull() {translate([0,0,0.005]) cube([30,40,0.01], center=true); translate([0,0,9.995]) cube([20,30,0.01], center=true);}` -`xcyl(l=20, d=4);` | `rotate([0,90,0]) cylinder(h=20, d=4, center=true);` -`rcylinder(h=100, d=40, fillet=5);` | `translate([0,0,50]) minkowski() {cylinder(h=90, d=30, center=true); sphere(r=5);}` +`BOSL/shapes.scad` Examples | Raw OpenSCAD Equivalent +---------------------------------- | ------------------------------- +`upcube([10,20,30]);` | `translate([0,0,15]) cube([10,20,30], center=true);` +`rcube([20,20,30],r=5,$fn=32);` | `minkowski() {cube([10,10,20], center=true); sphere(r=5, $fn=32);}` +`trapezoid([30,40],[20,30],h=10);` | `hull() {translate([0,0,0.005]) cube([30,40,0.01], center=true); translate([0,0,9.995]) cube([20,30,0.01],center=true);}` +`xcyl(l=20,d=4);` | `rotate([0,90,0]) cylinder(h=20, d=4, center=true);` +`rcylinder(h=100,d=40,fillet=5);` | `translate([0,0,50]) minkowski() {cylinder(h=90, d=30, center=true); sphere(r=5);}` -`BOSL/masks.scad` Examples | Raw Openscad Equivalent ------------------------------------- | ------------------------------- -`chamfer_mask_z(l=20, chamfer=5);` | `rotate(45) cube([5*sqrt(2), 5*sqrt(2), 20], center=true);` -`fillet_mask_z(l=20, fillet=5);` | `difference() {cube([10,10,20], center=true); for(dx=[-5,5],dy=[-5,5]) translate([dx,dy,0]) cylinder(h=20.1, r=5, center=true);}` -`fillet_hole_mask(r=30, fillet=5);` | `difference() {cube([70,70,10], center=true); translate([0,0,-5]) rotate_extrude(convexity=4) translate([30,0,0]) circle(r=5);}` +`BOSL/masks.scad` Examples | Raw Openscad Equivalent +----------------------------------- | ------------------------------- +`chamfer_mask_z(l=20,chamfer=5);` | `rotate(45) cube([5*sqrt(2), 5*sqrt(2), 20], center=true);` +`fillet_mask_z(l=20,fillet=5);` | `difference() {cube([10,10,20], center=true); for(dx=[-5,5],dy=[-5,5]) translate([dx,dy,0]) cylinder(h=20.1, r=5, center=true);}` +`fillet_hole_mask(r=30,fillet=5);` | `difference() {cube([70,70,10], center=true); translate([0,0,-5]) rotate_extrude(convexity=4) translate([30,0,0]) circle(r=5);}` ## The Library Files