leafbuild 0.0.1-dev.1

A WIP C/C++ buildsystem.
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

# Root makefile recipes

They can be invoked via
```sh
cargo make <recipe_name>
# or
makers <recipe_name> 
```

## `format`
Formats all the source files.

## `clean`
Calls cargo clean, removing all built artifacts.

## `build`
Builds the `leafbuild` executable.

## `lint`
Calls our good friend `clippy` to help improve code(denies warnings!).

## `check`
Checks the database, by first formatting, then invoking clippy and testing.
This should usually be invoked before a commit.

## `doc-build`
Invokes `mdbook` to build `doc/book` from `doc/src`.

## `doc-serve`
Invokes `mdbook` to serve the built files on [localhost:3000](http://localhost:3000).

## `doc-nuke`
Cleans up the currently-built book in `doc/book`.

## `doc-push`
Pushes the built doc to [the docs repo](https://github.com/leafbuild/docs).

## `doc-build-highlighter`
Builds the syntax highlighter from the highlight.js repo with `doc/leafbuild_highlight.js`.
More about the highlighter [here]().