A documented mechanical design library for OpenSCAD.
In order to use omdl, it should be be installed to the OpenSCAD library location. It can be copied manually, as described in the OpenSCAD documentation, or can be installed via openscad-amu (the framework used to develop omdl). If latter is used, the library will be tested and the documentation will be generated.
A setup script is available to download, build, and install the dependencies.
To setup the library to a temporary directory using the setup script, open the command shell and type:
mkdir tmp && cd tmp
wget https://git.io/setup-omdl.bash && chmod +x setup-omdl.bash
./setup-omdl.bash --cache --branch-list tags1 --yes --install
The option --yes
can be omitted if you prefer to confirm the
installation of the required packages (see: setup-omdl.bash --help
for more details). If you don't like shortened URLs, here is the full
URL to setup-omdl.bash at the source repository.
Once setup successfully completes, the library documentation can be viewed from the temporary 'cache' directory:
firefox cache/local/share/OpenSCAD/docs/html/index.html
To setup the development branch, use:
./setup-omdl.bash --cache --branch develop --yes --install
To install the latest release to the standard OpenSCAD user library path, use these options:
./setup-omdl.bash --branch-list tags1 --no-excludes --yes --install
To install a specific version, ie v0.6.1, use:
./setup-omdl.bash --branch v0.6.1 --no-excludes --yes --install
omdl uses git for development tracking, and is hosted on GitHub following the usual practice of forking and submitting pull requests to the source repository.
As it is released under the GNU Lesser General Public License, any file you change should bear your copyright notice alongside the original authors' copyright notices typically located at the top of each file.
Ideas, requests, comments, contributions, and constructive criticism are welcome.
Please feel free to raise any problems, concerns, or issues.