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 11:03:04 -05:00
parent 15f3034b0d
commit 2a7d6e2e08
1 changed files with 21 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
README.md
View File

@ -9,10 +9,10 @@ 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 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. 1. Checks for Homebrew and installs it if not found.
2. Installs OpenSCAD using Homebrew if it is not already installed. 2. Installs OpenSCAD using Homebrew if it is not already installed.
3. Creates the OpenSCAD libraries directory if it does not exist. 3. Creates the OpenSCAD libraries directory if it does not exist.
4. Clones or updates the following libraries into the OpenSCAD libraries directory: 4. Clones or updates the following libraries into the OpenSCAD libraries directory:
* BOSL2: https://github.com/BelfrySCAD/BOSL2 * BOSL2: https://github.com/BelfrySCAD/BOSL2
* BOSL: https://github.com/revarbat/BOSL * BOSL: https://github.com/revarbat/BOSL
* MCAD: https://github.com/openscad/MCAD * MCAD: https://github.com/openscad/MCAD
@ -22,32 +22,31 @@ curl -sL https://git.nixc.us/colin/OpenSCAD/raw/branch/main/install.sh | bash
* OpenSCAD Connectors: https://github.com/kellyegan/OpenSCAD-Arduino-Mounting-Library * OpenSCAD Connectors: https://github.com/kellyegan/OpenSCAD-Arduino-Mounting-Library
* BezierScad: https://github.com/chadkirby/BezierScad * BezierScad: https://github.com/chadkirby/BezierScad
* Chamfers for OpenSCAD: https://github.com/SebiTimeWaster/Chamfers-for-OpenSCAD * Chamfers for OpenSCAD: https://github.com/SebiTimeWaster/Chamfers-for-OpenSCAD
5. Validates the installation and reports success or failure. 5. Validates the installation and reports success or failure.
### Verifying the Installation ### Verifying the Installation
1. Open OpenSCAD and create a new file. 1. Open OpenSCAD and create a new file.
2. Add the following test code: 2. Add the following test code:
``` ```
use <BOSL2/std.scad>; use <BOSL2/std.scad>;
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.
3. Press F5 (Preview) or F6 (Render). If no errors appear, the installation was successful.
Troubleshooting Troubleshooting
1. Ensure Homebrew is installed by visiting https://brew.sh/. 1. Ensure Homebrew is installed by visiting https://brew.sh/.
2. Verify Git is installed and accessible by running: 2. Verify Git is installed and accessible by running:
``` ```
git --version 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/ ls ~/Documents/OpenSCAD/libraries/
``` ```
4. Verify OpenSCAD is installed by running: 4. Verify OpenSCAD is installed by running:
``` ```
openscad --version openscad --version
``` ```