{"id":22873732,"url":"https://github.com/royasutton/openscad-amu","last_synced_at":"2025-09-02T18:38:54.562Z","repository":{"id":206086149,"uuid":"62848242","full_name":"royasutton/openscad-amu","owner":"royasutton","description":"OpenSCAD AutoMake Utilities","archived":false,"fork":false,"pushed_at":"2024-10-21T21:42:05.000Z","size":1372,"stargazers_count":13,"open_issues_count":0,"forks_count":1,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-10-22T17:22:23.922Z","etag":null,"topics":["design-flow","design-framework","doxygen","openscad","openscad-amu","openscad-omdl"],"latest_commit_sha":null,"homepage":"https://royasutton.github.io/openscad-amu/","language":"C++","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/royasutton.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"COPYING","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2016-07-08T01:06:36.000Z","updated_at":"2024-09-25T18:03:15.000Z","dependencies_parsed_at":"2023-11-10T11:31:15.220Z","dependency_job_id":"a154db2a-9473-4803-87ee-20acaa5263d1","html_url":"https://github.com/royasutton/openscad-amu","commit_stats":null,"previous_names":["royasutton/openscad-amu"],"tags_count":28,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/royasutton%2Fopenscad-amu","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/royasutton%2Fopenscad-amu/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/royasutton%2Fopenscad-amu/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/royasutton%2Fopenscad-amu/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/royasutton","download_url":"https://codeload.github.com/royasutton/openscad-amu/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252751855,"owners_count":21798695,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["design-flow","design-framework","doxygen","openscad","openscad-amu","openscad-omdl"],"created_at":"2024-12-13T14:30:00.488Z","updated_at":"2025-05-06T18:58:30.483Z","avatar_url":"https://github.com/royasutton.png","language":"C++","funding_links":[],"categories":[],"sub_categories":[],"readme":"openscad-amu\n============\n\n\u003e Compile automation and source-based documentation for OpenSCAD designs.\n\n[![GPL licensed](https://img.shields.io/badge/license-GPL-blue.svg?style=flat)](https://raw.githubusercontent.com/royasutton/openscad-amu/master/COPYING)\n\n\nSetup\n-----\n\nTo use [openscad-amu], it needs to be installed to your development\nsystem. Although this can be done manually, it is recommended to use\nthe provided setup script.\n\n\nInstalling\n----------\n\nThe setup script can be used to bootstrap the development environment\nand its dependencies. To install the prerequisites, fetch and compile\nthe source, and install the latest tagged version of [openscad-amu],\nopen a shell and type:\n\n```bash\nmkdir tmp \u0026\u0026 cd tmp\n```\n\n```bash\nwget https://git.io/setup-amu.bash \u0026\u0026 chmod +x setup-amu.bash\n```\n\n```bash\n./setup-amu.bash --branch-list tags1 --yes --build --sudo --install\n```\n\nThe option `--yes` can be omitted if you prefer to confirm the\ninstallation of required packages. If you don't like shortened URLs,\nhere is the full URL to [setup-amu.bash].\n\nOnce setup has completed, the *cache* directory can be removed.\n\n### Options\n\nIn some cases you may wish to install several versions of the\ndevelopment tools concurrently. For example, to install the last three\ntagged versions, replace `tags1` with `tags3` in the prior command.\n\nTo uninstall everything that was installed by these step, repeat the\nstep above replacing `--install` with `--uninstall`. More help and\nexamples are available (see: `setup-amu.bash --help` and\n`setup-amu.bash --examples`).\n\nTo build and install the [openscad-amu] documentation, type:\n\n```bash\n./setup-amu.bash --branch-list tags1 --yes --build-docs --sudo --install-docs\n```\nSubsequently, the compiled documentation can be viewed with:\n\n```bash\ngoogle-chrome /usr/local/share/openscad-amu/v3.4/doc/doxygen/html/index.html\n```\n\n\nProject Template\n----------------\n\nTo create a new project from a template, type:\n\n```bash\n./setup-amu.bash --template my_project\n```\n\nThis will create a folder name *my_project* with a basic design\ntemplate and project *makefile*. The project *makefile* coordinates the\ndesign flow and invocation of [OpenSCAD]. All openscad-amu design flow\nconfigurations are set here. To see a menu of options, current\nconfigurations, build, and install this example project, type:\n\n```bash\ncd my_project\n\nmake help\nmake info\n\nmake all\nmake install\n```\n\nThe `make all` step will invoke OpenSCAD to compile the example design\ntargets, as specified by scripts embedded in the source comments, and\nprocess the comment-embedded documentation (via [Doxygen]). The `make\ninstall` step will install this example project to the standard\nOpenSCAD user library path.\n\nTo see this documentation, type:\n\n```bash\ngoogle-chrome `make echo-install_prefix_html`/index.html\n```\n\nTo remove the installed example project documentation, type:\n\n```bash\nmake uninstall\n```\n\nThis template provides a basic staring point for new designs using\nopenscad-amu.\n\n\nContributing\n------------\n\nopenscad-amu uses [git] for development tracking, and is hosted on\n[GitHub] following the usual practice of [forking] and submitting\n[pull requests] to the source [repository].\n\nAs it is released under the [GNU General Public License], any file you\nchange should bear your copyright notice alongside the original\nauthors' copyright notices typically located at the top of each file.\n\n\nContact and Support\n-------------------\n\nIn case you have any questions or would like to make feature requests,\nyou can contact the maintainer of the project or file an [issue].\n\n\n[GNU General Public License]: https://www.gnu.org/licenses/gpl.html\n\n[setup-amu.bash]: https://raw.githubusercontent.com/royasutton/openscad-amu/master/share/scripts/setup-amu.bash\n\n[openscad-amu]: https://royasutton.github.io/openscad-amu\n[repository]: https://github.com/royasutton/openscad-amu\n[issue]: https://github.com/royasutton/openscad-amu/issues\n\n[OpenSCAD]: http://www.openscad.org/\n\n[Doxygen]: http://www.doxygen.nl\n\n[git]: http://git-scm.com/\n[GitHub]: http://github.com/\n[forking]: http://help.github.com/forking/\n[pull requests]: https://help.github.com/articles/about-pull-requests/\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Froyasutton%2Fopenscad-amu","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Froyasutton%2Fopenscad-amu","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Froyasutton%2Fopenscad-amu/lists"}