makemake 0.1.2-patch1

Library for building Makefiles programmatically
Documentation 
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

# makemake

![CI](https://github.com/ethanuppal/makemake/actions/workflows/ci.yaml/badge.svg)
[![CodeFactor](https://www.codefactor.io/repository/github/ethanuppal/makemake/badge)](https://www.codefactor.io/repository/github/ethanuppal/makemake)

`makemake` is a rust library for building Makefiles programmatically.

## Usage

Run this command in your rust project root:
```
cargo add makemake
```
You can find the crate [on crates.io](https://crates.io/crates/makemake).

## Example

Let's build a Makefile for a C project.
```rs
let mut makefile = Makefile::new();
```

We'll want variables for the source files, object files, compiler, and flags.
```rs
let src = makefile.assign("SRC", Function::wildcard(["src/*.c".into()]));
let obj = makefile.assign("OBJ", Substitution::new(src, ".c", ".o"));
let cc = makefile.assign_without_overwrite(
    "CC",
    Function::shell("which gcc || which clang")
);
let cflags = makefile.append("CFLAGS", "-std=c99 -Wall -Wextra");
let target = makefile.assign("TARGET", "main");
```

Next, we'll define the rule to create the target.
```rs
makefile.rule(target).dep("main.c").dep(obj).cmd(expr!(
    cc,
    cflags,
    "-o",
    makefile.target_var(),
    makefile.deps_var()
));
```

Finally, we can print the resultant Makefile.
```rs
print!("{}", makefile.build());
```

Indeed, we can use our Makefile to build an example project.
```shell
cargo run --example c_project > examples/Makefile
cd examples
make && ./main
```
The actual example also comes with a `make clean`!

## License

This project is licensed under the [MIT License](LICENSE), a copy of which is available in this directory.