microcad 0.5.0

µcad Command Line Interface
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101

# microcad

[![Crates.io](https://img.shields.io/crates/v/microcad.svg)](https://crates.io/crates/microcad)
[![Documentation](https://docs.rs/microcad/badge.svg)](https://docs.rs/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:

```sh
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](https://cmake.org/) and [Ninja](https://github.com/ninja-build/ninja) which are needed to compile
the [manifold geometry library](https://github.com/elalish/manifold).

### *Debian* based *Linux* distributions

Use the following line to install Ninja and CMake:

```sh
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`:

```sh
brew install cmake ninja
```

### Install µcad via cargo

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

```sh
cargo install microcad
```

## Run

Start the microcad CLI by typing `microcad` into your console.

```sh
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):

```sh
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

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

### Generate mdbook for µcad standard library

```sh
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](https://microcad.xyz).

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

<a href="https://opencollective.com/microcad/donate" target="_blank">
<img src="https://opencollective.com/microcad/donate/button@2x.png?color=blue" width=300 />
</a>