From 2a7d6e2e082ad994fbd366cec2f4cace0b8907d0 Mon Sep 17 00:00:00 2001 From: colin Date: Thu, 12 Dec 2024 11:03:04 -0500 Subject: [PATCH] Update README.md --- README.md | 43 +++++++++++++++++++++---------------------- 1 file changed, 21 insertions(+), 22 deletions(-) diff --git a/README.md b/README.md index 918b2d5..e6ac2f6 100644 --- a/README.md +++ b/README.md @@ -9,45 +9,44 @@ 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 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 - * 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 - * Chamfers for OpenSCAD: https://github.com/SebiTimeWaster/Chamfers-for-OpenSCAD - 5. Validates the installation and reports success or failure. +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 + * 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 + * Chamfers for OpenSCAD: https://github.com/SebiTimeWaster/Chamfers-for-OpenSCAD +5. 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: +1. Open OpenSCAD and create a new file. +2. Add the following test code: ``` use ; cube([10, 10, 10], center = true); ``` - - 3. Press F5 (Preview) or F6 (Render). If no errors appear, the installation was successful. +3. 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: +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: +3. Confirm the libraries exist in the OpenSCAD libraries directory: ``` ls ~/Documents/OpenSCAD/libraries/ ``` - 4. Verify OpenSCAD is installed by running: +4. Verify OpenSCAD is installed by running: ``` openscad --version ``` \ No newline at end of file