Skip to content

Commit

Permalink
Added a TOC to the readme for the contents of the repo
Browse files Browse the repository at this point in the history
  • Loading branch information
jmwright committed Jan 2, 2021
1 parent 8be7f8f commit 9eba89a
Showing 1 changed file with 23 additions and 1 deletion.
24 changes: 23 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,24 @@
# cadquery-contrib
A place to share cadquery scripts, modules, and projects
A place to share CadQuery scripts, modules, tutorials and projects

## Contents

### Examples

* [3D_Printer_Extruder_Support.py](examples/3D_Printer_Extruder_Support.py) - Designed for mounting hotend to an i3 X-carriage inspired by the P3steel Toolson
* [Braille.py](examples/Braille.py) - Configurable braille label/sign generator where user inputs text and the braille dots are generated automatically
* [Classic_OCC_Bottle.py](examples/Classic_OCC_Bottle.py) - Standard OCCT bottle example, implemented using the CadQuery API
* [Numpy.py](examples/Numpy.py) - Example of integrating Numpy with CadQuery
* [Panel_with_Various_Holes_for_Connector_Installation.py](examples/Panel_with_Various_Holes_for_Connector_Installation.py) - Example of creating various knock-out holes in a panel
* [Parametric_Enclosure.py](examples/Parametric_Enclosure.py) - Standard CadQuery example of an electronics enclosure with a base, fastener bosses, and a lid
* [Reinforce_Junction_UsingFillet.py](examples/Reinforce_Junction_UsingFillet.py) - Example of using fillets to reinforce a joint, reducing stress concentrators at the joint
* [Remote_Enclosure.py](examples/Remote_Enclosure.py) - An electronics enclosure created to be mounted on motorcycle handlebars
* [Resin_Mold.py](examples/Resin_Mold.py) - A resin casting mold created to repair the strain-relief on an expensive cable
* [Shelled_Cube_Inside_Chamfer_With_Logical_Selector_Operators.py](examples/Shelled_Cube_Inside_Chamfer_With_Logical_Selector_Operators.py) - Shows a somewhat more advanced use of selectors to chamfer the inside edges of a shelled cube
* [tray.py](examples/tray.py) - Manual assembly example including export to DXF for laser cutting

### Tutorials

* [Ex000 Start Here.ipynb](tutorials/Ex000%20Start%20Here.ipynb) - iPython notebook that is the entry point for a set of CadQuery tutorials
* [Ex001 Simple Block.ipynb](tutorials/Ex001%20Simple%20Block.ipynb) - iPython notebook that shows how to create an extremely simple block

0 comments on commit 9eba89a

Please sign in to comment.