colin
/
OpenSCAD
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
It is just a curl 2 bash for parameterized modeling for OSX and standard libraries.
6 Commits 1 Branch 0 Tags 37 KiB
Shell 100%
Go to file
colin ea03ef03b0 Update README.md 2024-12-12 10:53:31 -05:00
README.md Update README.md 2024-12-12 10:53:31 -05:00
install.sh Update install.sh 2024-12-12 10:48:57 -05:00

README.md

OpenSCAD Baseline Setup Guide

This guide provides an automated setup process for OpenSCAD and a comprehensive set of commonly used libraries.

Quick Start: Automated Installation

Run the following command to install OpenSCAD, set up libraries, and validate the configuration:

curl -sL https://git.nixc.us/colin/OpenSCAD/raw/branch/main/install.sh | bash

What the Script Does

  1. Checks for Homebrew and installs it if not found.
  2. Installs OpenSCAD using Homebrew if it is not already installed.
  3. Creates the OpenSCAD libraries directory if it does not exist.
  4. Clones or updates the following libraries into the OpenSCAD libraries directory:
  5. BOSL2: https://github.com/BelfrySCAD/BOSL2
  6. BOSL: https://github.com/revarbat/BOSL
  7. MCAD: https://github.com/openscad/MCAD
  8. BOLTS: https://github.com/boltsparts/BOLTS
  9. Nuts and Bolts: https://github.com/JohK/nutsnbolts
  10. OpenSCAD Fillets: https://github.com/jfhbrook/openscad-fillets
  11. Shape Library: https://github.com/cznewt/openscad-model-library
  12. OpenSCAD Connectors: https://github.com/kellyegan/OpenSCAD-Arduino-Mounting-Library
  13. BezierScad: https://github.com/chadkirby/BezierScad
  14. Tracklib: https://github.com/joostn/OpenSCAD-Track
  15. Chamfers for OpenSCAD: https://github.com/SebiTimeWaster/Chamfers-for-OpenSCAD
  16. U-Joint Library: https://github.com/celer/openjscad-u-joints
  17. Validates the installation and reports success or failure.

Verifying the Installation

  1. Open OpenSCAD and create a new file.
  2. Add the following test code:
use <BOSL2/std.scad>;

cube([10, 10, 10], center = true);
  1. Press F5 (Preview) or F6 (Render). If no errors appear, the installation was successful.

Troubleshooting

  1. Ensure Homebrew is installed by visiting https://brew.sh/.
  2. Verify Git is installed and accessible by running git --version.
  3. Confirm the libraries exist in the OpenSCAD libraries directory:
ls ~/Documents/OpenSCAD/libraries/
  1. Verify OpenSCAD is installed by running:
openscad --version

Refer to the documentation or GitHub repositories for additional support or information.