From ed99ac4df69155dba3c64eb9a54909b2ced693a4 Mon Sep 17 00:00:00 2001 From: colin Date: Thu, 12 Dec 2024 10:52:32 -0500 Subject: [PATCH] Update README.md --- README.md | 74 ++++++++++++++++++++++++++++--------------------------- 1 file changed, 38 insertions(+), 36 deletions(-) diff --git a/README.md b/README.md index 8bd0c91..21a173d 100644 --- a/README.md +++ b/README.md @@ -8,49 +8,51 @@ Run the following command to install OpenSCAD, set up libraries, and validate th ```bash curl -sL https://git.nixc.us/colin/OpenSCAD/raw/branch/main/install.sh | bash +``` + +### What the Script Does -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: - • 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. + 1. Installs OpenSCAD using Homebrew if it is not already installed. + 1. Creates the OpenSCAD libraries directory if it does not exist. + 1. Clones or updates the following libraries into the OpenSCAD libraries directory: + 1. BOSL2: https://github.com/BelfrySCAD/BOSL2 + 1. BOSL: https://github.com/revarbat/BOSL + 1. MCAD: https://github.com/openscad/MCAD + 1. BOLTS: https://github.com/boltsparts/BOLTS + 1. Nuts and Bolts: https://github.com/JohK/nutsnbolts + 1. OpenSCAD Fillets: https://github.com/jfhbrook/openscad-fillets + 1. Shape Library: https://github.com/cznewt/openscad-model-library + 1. OpenSCAD Connectors: https://github.com/kellyegan/OpenSCAD-Arduino-Mounting-Library + 1. BezierScad: https://github.com/chadkirby/BezierScad + 1. Tracklib: https://github.com/joostn/OpenSCAD-Track + 1. Chamfers for OpenSCAD: https://github.com/SebiTimeWaster/Chamfers-for-OpenSCAD + 1. U-Joint Library: https://github.com/celer/openjscad-u-joints + 1. Validates the installation and reports success or failure. -Verifying the Installation +### Verifying the Installation 1. Open OpenSCAD and create a new file. - 2. Add the following test code: + 1. Add the following test code: + ``` + use ; -use ; + cube([10, 10, 10], center = true); + ``` -cube([10, 10, 10], center = true); - - - 3. Press F5 (Preview) or F6 (Render). If no errors appear, the installation was successful. - -Troubleshooting - • 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: - -ls ~/Documents/OpenSCAD/libraries/ - - - • Verify OpenSCAD is installed by running: - -openscad --version + 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/. + 1. Verify Git is installed and accessible by running git --version. + 1. 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. \ No newline at end of file