Repository files navigation

Compile automation and source-based documentation for OpenSCAD designs.

To useopenscad-amu, it needs to be installed to your developmentsystem. Although this can be done manually, it is recommended to usethe provided setup script.

The setup script can be used to bootstrap the development environmentand its dependencies. To install the prerequisites, fetch and compilethe source, and install the latest tagged version ofopenscad-amu,open a shell and type:

mkdir tmp&&cd tmp

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

./setup-amu.bash --branch-list tags1 --yes --build --sudo --install

The option--yes can be omitted if you prefer to confirm theinstallation of required packages. If you don't like shortened URLs,here is the full URL tosetup-amu.bash.

Once setup has completed, thecache directory can be removed.

In some cases you may wish to install several versions of thedevelopment tools concurrently. For example, to install the last threetagged versions, replacetags1 withtags3 in the prior command.

To uninstall everything that was installed by these step, repeat thestep above replacing--install with--uninstall. More help andexamples are available (see:setup-amu.bash --help andsetup-amu.bash --examples).

To build and install theopenscad-amu documentation, type:

./setup-amu.bash --branch-list tags1 --yes --build-docs --sudo --install-docs

Subsequently, the compiled documentation can be viewed with:

google-chrome /usr/local/share/openscad-amu/v3.4/doc/doxygen/html/index.html

To create a new project from a template, type:

./setup-amu.bash --template my_project

This will create a folder namemy_project with a basic designtemplate and projectmakefile. The projectmakefile coordinates thedesign flow and invocation ofOpenSCAD. All openscad-amu design flowconfigurations are set here. To see a menu of options, currentconfigurations, build, and install this example project, type:

cd my_projectmakehelpmake infomake allmake install

Themake all step will invoke OpenSCAD to compile the example designtargets, as specified by scripts embedded in the source comments, andprocess the comment-embedded documentation (viaDoxygen). Themake install step will install this example project to the standardOpenSCAD user library path.

To see this documentation, type:

google-chrome`make echo-install_prefix_html`/index.html

To remove the installed example project documentation, type:

make uninstall

This template provides a basic staring point for new designs usingopenscad-amu.

openscad-amu usesgit for development tracking, and is hosted onGitHub following the usual practice offorking and submittingpull requests to the sourcerepository.

As it is released under theGNU General Public License, any file youchange should bear your copyright notice alongside the originalauthors' copyright notices typically located at the top of each file.

In case you have any questions or would like to make feature requests,you can contact the maintainer of the project or file anissue.