omdl

An open-source parametric framework for mechanical design in OpenSCAD.

Setup

To use omdl, it must be installed in the OpenSCAD library location.
A setup script is provided to simplify the installation and
configuration process. This script can optionally install
openscad-amu, the design-flow automation framework used to test the
library and generate its documentation.

The setup script is the recommended installation method. Alternatively,
online snapshots are available for manual installation at
omdl-snapshot. These snapshots also allow you to review the latest
release documentation before installing the library locally.

Installing

To install the latest tagged release of omdl, use the following
steps:

mkdir tmp && cd tmp

wget https://git.io/setup-omdl.bash && chmod +x setup-omdl.bash

./setup-omdl.bash --branch-list tags1 --no-excludes --yes --install

The --yes option may be omitted if you prefer to manually confirm the
installation of required packages. If shortened URLs are not preferred,
the full URL to setup-omdl.bash is available in the source repository
at setup-omdl.bash. After setup completes, the temporary cache
directory may be safely removed.

To view the installed library documentation, run:

google-chrome ${HOME}/.local/share/OpenSCAD/docs/html/index.html

Options

To install a specific library version, use:

./setup-omdl.bash --branch v0.6.1 --no-excludes --yes --install

To install a specific library version along with the openscad-amu
version used to build the library, use:

./setup-omdl.bash --branch v0.9.7 --no-excludes --yes --local-toolchain --install

For a complete list of setup options, type;

./setup-omdl.bash --help

Contributing

omdl uses git for source control and development tracking, and is
hosted on GitHub. Contributions follow the standard open-source
workflow of creating a [fork] and submitting changes through pull
requests to the main repository.

Because the project is released under the [GNU Lesser General Public
License (LGPL)], any modified file should retain the original copyright
notices and include your own copyright statement alongside those of the
original authors. These notices are typically located at the beginning
of each source file.

Ideas, feature requests, feedback, contributions, and constructive
criticism are always welcome and encouraged.

Bug reporting

Users and contributors are encouraged to report problems, concerns, or
suggestions by submitting an [issue].