colin
/
OpenSCAD
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update README.md

This commit is contained in:
colin 2024-12-12 10:50:38 -05:00
parent 6284d584de
commit 00c9634fed
1 changed files with 27 additions and 29 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

54
README.md
View File

@ -1,6 +1,6 @@
# OpenSCAD Baseline Setup Guide
This guide provides an automated setup process for OpenSCAD and libraries like BOSL2 and BOSL. It includes validation steps to ensure the installation is successful.
This guide provides an automated setup process for OpenSCAD and a comprehensive set of commonly used libraries.
## Quick Start: Automated Installation
@ -10,49 +10,47 @@ Run the following command to install OpenSCAD, set up libraries, and validate th
curl -sL https://git.nixc.us/colin/OpenSCAD/raw/branch/main/install.sh | bash
What the Script Does
1. Checks for Homebrew:
• Ensures Homebrew is installed. If not, it halts and provides a link to install it.
2. Installs OpenSCAD:
• Installs OpenSCAD using Homebrew if it’s not already installed.
3. Sets Up the OpenSCAD Libraries Directory:
• Creates the directory ~/Documents/OpenSCAD/libraries/ if it doesn’t already exist.
4. Clones BOSL2 and BOSL:
• Clones the repositories for BOSL2 and BOSL into the libraries directory.
• If the repositories already exist, it updates them using git pull.
5. Validates the Installation:
• Ensures OpenSCAD is properly installed and available on the system.
• Checks that both BOSL2 and BOSL directories exist in the correct location.
6. Reports Success or Failure:
• If any step fails, the script provides a diagnostic message to help resolve the issue.
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:
• BOSL2: https://github.com/BelfrySCAD/BOSL2
• BOSL: https://github.com/revarbat/BOSL
• MCAD: https://github.com/openscad/MCAD
• BOLTS: https://github.com/boltsparts/BOLTS
• Nuts and Bolts: https://github.com/JohK/nutsnbolts
• OpenSCAD Fillets: https://github.com/jfhbrook/openscad-fillets
• Shape Library: https://github.com/cznewt/openscad-model-library
• OpenSCAD Connectors: https://github.com/kellyegan/OpenSCAD-Arduino-Mounting-Library
• BezierScad: https://github.com/chadkirby/BezierScad
• Tracklib: https://github.com/joostn/OpenSCAD-Track
• Chamfers for OpenSCAD: https://github.com/SebiTimeWaster/Chamfers-for-OpenSCAD
• U-Joint Library: https://github.com/celer/openjscad-u-joints
5. Validates the installation and reports success or failure.
Verifying the Installation
1. Open OpenSCAD and create a new file.
2. Add the following code:
2. Add the following test code:
use <BOSL2/std.scad>;
cube([10, 10, 10], center = true);
3. Press F5 (Preview) or F6 (Render). If there are no errors, the installation was successful.
3. Press F5 (Preview) or F6 (Render). If no errors appear, the installation was successful.
Troubleshooting
• Homebrew not installed:
• Install Homebrew from https://brew.sh/.
• Git issues:
• Ensure Git is installed and working. Run:
• Ensure Homebrew is installed by visiting https://brew.sh/.
• Verify Git is installed and accessible by running git --version.
• Confirm the libraries exist in the OpenSCAD libraries directory:
git --version
ls ~/Documents/OpenSCAD/libraries/
• Libraries not found:
• Verify the libraries are located in ~/Documents/OpenSCAD/libraries/.
• If missing, re-run the script.
• OpenSCAD not found:
• Verify the installation by running:
• Verify OpenSCAD is installed by running:
openscad --version
Refer to the BOSL2 GitHub repository and BOSL GitHub repository for additional documentation or support.
Refer to the documentation or GitHub repositories for additional support or information.