microcad

This crate provides a command line interface for µcad language.

Note: This project is in an early stage of development and is not yet feature complete!

Quick Start

To process a µcad file and export its geometry into an STL, use the following command:

microcad export ./examples/bricks/brick

This will export the 3D geometry description in ./examples/bricks/brick.µcad as a brick.stl file.

Installation

First, install CMake and Ninja which are needed to compile the manifold geometry library.

Debian based Linux distributions

Use the following line to install Ninja and CMake:

sudo apt install ninja-build cmake

Pre-built debian packages which are attached to our release logs:

MacOS

If you are on using MacOS, you have to install cmake and ninja using brew:

brew install cmake ninja

Install µcad via cargo

To install the latest release of µcad via cargo, type:

cargo install microcad

Run

Start the microcad CLI by typing microcad into your console.

microcad

You're now ready to use µcad!

Command line usage

To generate an STL model file, use the export command (with an optional output file name):

microcad export ./examples/bricks/brick

This will export the geometry into a brick.stl file.

Generate documentation

You can generate documentation with microcad doc for source files.

Generate mdbook for built-in library

microcad doc -g mdbook __builtin --output books/builtin

Generate mdbook for µcad standard library

microcad doc -g mdbook 'crates/std/lib/std/mod.µcad' --output books/std`

Resources

• Documentation: https://docs.microcad.xyz/language/book/index.html
• µcad Viewer: https://crates.io/crates/microcad-viewer/

❤️ Support the project

This crate is part of the microcad project.

If you like this project, you can help us spend more time on it by donating: