aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: 4925f2edd0329efaae1ce098c544f142698f9c15 (plain)
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
# wmap

Command line tool to generate wardley map images from wmap files.

## How to use

TBD

# Building

This project is built using cargo. A makefile is provided to run common tasks.

Build dev version with `make` or `make build`.

Build release with `make -e profile=release` or `make -e profile=release build`.

Run tests with `make test`.

If you have [tarpaulin][tarpaulin], you can also run `make coverage` to get
coverage information.

# Distribution of Builds

Builds are available at [build.r.bdr.sh][rbdr-builds]. The linux builds are
generated automatically by the CI: Unstable builds are built from the `main`
branch, and stable releases are built from tags.

For mac, the process is still manual, since the commands need to be run from
a macos machine by running `make mac` for unstable builds, and
`make -e tag=M.m.p` for stable builds.

[tarpaulin]: https://github.com/xd009642/tarpaulin
[rbdr-builds]: https://build.r.bdr.sh/wmap/