From bbb47465ae4cc00ca333b03ad10912a373a2ad60 Mon Sep 17 00:00:00 2001 From: Revar Desmera Date: Wed, 3 May 2023 20:20:26 -0700 Subject: [PATCH] Fixed some README issues. --- README.md | 18 +++++++++++------- 1 file changed, 11 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index afb4f6e..fec0aee 100644 --- a/README.md +++ b/README.md @@ -10,11 +10,17 @@ Requires OpenSCAD 2021.01 or later. - **NOTE:** BOSL2 IS BETA CODE. THE CODE IS STILL BEING REORGANIZED. - **NOTE2:** CODE WRITTEN FOR BOSLv1 PROBABLY WON'T WORK WITH BOSL2! -[![Join the chat at https://gitter.im/revarbat/BOSL2](https://badges.gitter.im/revarbat/BOSL2.svg)](https://gitter.im/revarbat/BOSL2?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) [**BOSL2 Docs**](https://github.com/revarbat/BOSL2/wiki) +[![Join the chat at https://gitter.im/revarbat/BOSL2](https://badges.gitter.im/revarbat/BOSL2.svg)](https://gitter.im/revarbat/BOSL2?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) + + +## Documentation + +You can find the full BOSL2 library documentation at: https://github.com/revarbat/BOSL2/wiki + ## Installation -1. Download the .zip or .tar.gz release file for this library. +1. Download the .zip or .tar.gz release file for this library. Currently you should be able to find this at https://github.com/revarbat/BOSL2/archive/refs/heads/master.zip 2. Unpack it. Make sure that you unpack the whole file structure. Some zipfile unpackers call this option "Use folder names". It should create either a `BOSL-v2.0` or `BOSL2-master` directory with the library files within it. You should see "examples", "scripts", "tests", and other subdirectories. 3. Rename the unpacked main directory to `BOSL2`. 4. Move the `BOSL2` directory into the apropriate OpenSCAD library directory for your platform: @@ -41,10 +47,8 @@ A lot of the features of this library are to allow shorter, easier-to-read, inte `cuboid([20,20,30], rounding=5);` | `minkowski() {cube([10,10,20], center=true); sphere(r=5, $fn=32);}` `prismoid([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);` -`cyl(l=100, d=40, rounding=5);` | `translate([0,0,50]) minkowski() {cylinder(h=90, d=30, center=true); sphere(r=5);}` - - -## Documentation -The full library docs can be found at https://github.com/revarbat/BOSL2/wiki +`cyl(l=100, d=40, rounding=5);` | `minkowski() {cylinder(h=90, d=30, center=true); sphere(r=5);}` +`tube(od=40,wall=5,h=30);` | `difference() {cylinder(d=40,h=30,center=true); cylinder(d=30,h=31,center=true);}` +`torus(d_maj=100, d_min=30);` | `rotate_extrude() translate([50,0,0]) circle(d=30);`