Setup Script

A script is provided to build the library documentation. If the setup script does not detect that openscad-amu, the development environment used by omdl, is installed, it will automatically download and configure it in a local cache directory within the current path. This ensures that the documentation can be generated without requiring a system-wide installation of the development environment.

Download the omdl setup script:

$ mkdir tmp && cd tmp
 
$ wget https://raw.githubusercontent.com/royasutton/omdl/master/share/scripts/setup-omdl.bash
 
$ chmod +x setup-omdl.bash

Fetch and install the latest library distribution:

$ ./setup-omdl.bash --branch-list tags1 --yes --install

or, a specific version, say v0.9.6, can be installed using:

$ ./setup-omdl.bash --branch v0.9.6 --yes --install

View documentation:

$ google-chrome ~/.local/share/OpenSCAD/docs/html/index.html

The generated HTML documentation will be installed to the OpenSCAD user library path in a subfolder named 'docs/html'.

The example above assumes a Linux operating system; paths may differ on other platforms.