Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/royasutton/omdl
OpenSCAD mechanical design library
https://github.com/royasutton/omdl
mechanical-design mechanical-design-library openscad openscad-amu openscad-library
Last synced: 22 days ago
JSON representation
OpenSCAD mechanical design library
- Host: GitHub
- URL: https://github.com/royasutton/omdl
- Owner: royasutton
- Created: 2016-11-28T23:05:15.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2024-10-29T12:34:45.000Z (2 months ago)
- Last Synced: 2024-10-29T15:01:03.230Z (2 months ago)
- Topics: mechanical-design, mechanical-design-library, openscad, openscad-amu, openscad-library
- Language: OpenSCAD
- Homepage: https://royasutton.github.io/omdl/
- Size: 12.8 MB
- Stars: 44
- Watchers: 7
- Forks: 6
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
omdl
====
> A documented mechanical design library for [OpenSCAD].
[](https://raw.githubusercontent.com/royasutton/omdl/master/gnu-lgpl-v2.1.txt)
Setup
-----
To use [omdl], it should be installed to the OpenSCAD [library
location]. This can be done manually, as described in the OpenSCAD
documentation, or can be done via [openscad-amu] (the design-flow
automation framework used to develop omdl). If latter is used, the
library will be tested and the documentation will be generated.
The provided setup script is the recommended install method.
Evaluation
----------
To setup the library to a temporary directory using the setup script,
open the command shell and type:
```bash
mkdir tmp && cd tmp
```
```bash
wget https://git.io/setup-omdl.bash && chmod +x setup-omdl.bash
```
```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 completes, the library documentation can be viewed from the
temporary 'cache' directory:
```bash
google-chrome cache/local/share/OpenSCAD/docs/html/index.html
```
To setup the development branch, use:
```bash
./setup-omdl.bash --cache --branch develop --yes --install
```
Installing
----------
To install the latest release to the standard OpenSCAD user library
path, use these options:
```bash
./setup-omdl.bash --branch-list tags1 --no-excludes --yes --install
```
To install a specific version, ie v0.6.1, use:
```bash
./setup-omdl.bash --branch v0.6.1 --no-excludes --yes --install
```
Once setup completes, the library documentation can be viewed from the
standard install location:
```bash
google-chrome ${HOME}/.local/share/OpenSCAD/docs/html/index.html
```
Contributing
------------
[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.
Bug reporting
-------------
Please feel free to raise any problems, concerns, or [issues].
[GNU Lesser General Public License]: https://www.gnu.org/licenses/lgpl.html
[setup-omdl.bash]: https://raw.githubusercontent.com/royasutton/omdl/master/share/scripts/setup-omdl.bash
[omdl]: https://royasutton.github.io/omdl
[repository]: https://github.com/royasutton/omdl
[issues]: https://github.com/royasutton/omdl/issues
[openscad-amu]: https://royasutton.github.io/openscad-amu
[installing openscad-amu]: https://github.com/royasutton/openscad-amu#installing
[Doxygen]: http://www.stack.nl/~dimitri/doxygen/index.html
[OpenSCAD]: http://www.openscad.org
[library location]: https://en.wikibooks.org/wiki/OpenSCAD_User_Manual/Libraries
[git]: http://git-scm.com
[GitHub]: http://github.com
[forking]: http://help.github.com/forking
[pull requests]: https://help.github.com/articles/about-pull-requests