aboutsummaryrefslogtreecommitdiff
path: root/rif/README.md
blob: e99b4c1c99a1fc7e2945a12d48ea9d6da8d062ae (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
# recipe instruction format (`rif`)

A strongly typed expression format for recipes.

Recipes consist of a schema which specifies available ingredients and
worksteps, some metadata that is largely computed from the actual
recipe, but can be queried from the main object, as well as a directed
graph of ingredient measures and worksteps separated into threads.

A thread is a set of instructions that can be executed by a single
actor.  Each thread has a set of inputs (ingredients) and an output,
which is it's own type, a mix of ingredients created by the thread.


## How to use

```rust
let schema = Schema::load("./main.rifs")?;
let recp = Recipe::
```