grey/BOSL2
1
0
Fork 0
mirror of https://github.com/BelfrySCAD/BOSL2.git synced 2024-12-29 16:29:40 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Minor tweaks to README

Browse source
This commit is contained in:
Revar Desmera 2017-08-29 19:11:59 -07:00
parent 491e47dffa
commit 88b7872ffe
1 changed files with 4 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
README.md
View file

@ -9,6 +9,7 @@ The library files are as follows:
- ```transforms.scad```: The most commonly used transformations, manipulations, and shortcuts are in this file. - ```transforms.scad```: The most commonly used transformations, manipulations, and shortcuts are in this file.
- ```shapes.scad```: Common useful shapes and structured objects. - ```shapes.scad```: Common useful shapes and structured objects.
- ```masks.scad```: Shapes that are useful for masking with ```difference()``` and ```intersect()```. - ```masks.scad```: Shapes that are useful for masking with ```difference()``` and ```intersect()```.
- ```math.scad```: Useful helper functions and constants.
- ```paths.scad```: Functions and modules to work with arbitrary 3D paths. - ```paths.scad```: Functions and modules to work with arbitrary 3D paths.
- ```bezier.scad```: Functions and modules to work with bezier curves. - ```bezier.scad```: Functions and modules to work with bezier curves.
- ```involute_gears.scad```: Modules and functions to make involute gears and racks. - ```involute_gears.scad```: Modules and functions to make involute gears and racks.
@ -19,7 +20,6 @@ The library files are as follows:
- ```nema_steppers.scad```: Modules to make mounting holes for NEMA motors. - ```nema_steppers.scad```: Modules to make mounting holes for NEMA motors.
- ```linear_bearings.scad```: Modules to make mounts for LMxUU style linear bearings. - ```linear_bearings.scad```: Modules to make mounts for LMxUU style linear bearings.
- ```wiring.scad```: Modules to render routed bundles of wires. - ```wiring.scad```: Modules to render routed bundles of wires.
- ```math.scad```: Useful helper functions and constants.
- ```quaternions.scad```: Functions to work with quaternion rotations. - ```quaternions.scad```: Functions to work with quaternion rotations.
## transforms.scad ## transforms.scad
@ -36,8 +36,9 @@ The most commonly useful of the library files is ```transforms.scad```. It prov
The ```shapes.scad``` library file provides useful compound shapes, such as: The ```shapes.scad``` library file provides useful compound shapes, such as:
- ```upcube()``` a ridiculously useful version of ```cube()``` that is centered on top of the XY plane. - ```upcube()``` a ridiculously useful version of ```cube()``` that is centered on top of the XY plane.
- Filleted (rounded) and Chamferred (bevelled) cubes and cylinders. - Filleted (rounded) and Chamferred (bevelled) cubes and cylinders.
- ```pyramid()```, ```prism()```, and ```trapezoid()``` - ```pyramid()``` and ```prism()```
- ```right_triangle()``` - The incredibly useful ```trapezoid()``` for non-parallelogram cubes.
- ```right_triangle()``` for the obvious shape.
- ```teardrop()``` and ```onion()``` for making more 3D printable holes. - ```teardrop()``` and ```onion()``` for making more 3D printable holes.
- ```tube()``` and ```torus()``` for donut shapes. - ```tube()``` and ```torus()``` for donut shapes.
- ```slot()``` and ```arced_slot()``` for making things like screw slots. - ```slot()``` and ```arced_slot()``` for making things like screw slots.