# wmap

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

## How to use

### Synopsis

```
wmap [OPTIONS] INPUT_FILE
```

### Description

wmap is a tool that lets you create png or svg images from a wmap formatted file.

### Options

- **-h, --help**: Display help.
- **-v, --version**: Display version information.
- **-t, --type <IMAGE_TYPE>**: Specifies the output type. Can be one of: `png`, or `svg`. Defaults to `png`.
- **-s, --stage <STAGE>**: Specifies the stage labels to use. Defaults to `activities`.
- **-o, --output <OUTPUT_FILE>**: The output file in which to write the image. Defaults to the same filename as the input map, but replacing the extension with either `png`, or `svg`.

### Stages

The renderer has the following built-in stage types available:

- **activities** - Genesis / Custom / Product (+rental) / Commodity (+utility)
- **behavior** - Uncertain when to use / Learning when to use / Learning through use / Known / common usage
- **certainty** - Poorly Understood / exploring the unknown / Rapid Increase In Learning / discovery becomes refining / Rapid increase in use / increasing fit for purpose / Commonly understood (in terms of use)
- **comparison** - Constantly changing / a differential / unstable / Learning from others / testing the water / some evidential support / Competing models / feature difference / evidential support / Essential / any advantage is operational / accepted norm
- **cynefin** - Chaotic / Complex / Complicated / Clear
- **data** - Unmodelled / Divergent / Convergent / Modelled
- **decision_drivers** - Heritage / culture / Analyses & synthesis / Analyses & synthesis / Previous Experience
- **efficiency** - Reducing the cost of change (experimentation) / Reducing cost of waste (Learning) / Reducing cost of waste (Learning) / Reducing cost of deviation (Volume)
- **failure** - High / tolerated / assumed to be wrong / Moderate / unsurprising if wrong but disappointed / Not tolerated / focus on constant improvement / assumed to be in the right direction / resistance to changing the model / Surprised by failure / focus on operational efficiency
- **focus_of_value** - High future worth but immediate investment / Seeking ways to profit and a ROI / seeking confirmation of value / High profitability per unit / a valuable model / a feeling of understanding / focus on exploitation / High volume / reducing margin / important but invisible / an essential component of something more complex
- **knowledge** - Concept / Hypothesis / Theory / Accepted
- **knowledge_management** - Uncertain / Learning on use / focused on testing prediction / Learning on operation / using prediction / verification / Known / accepted
- **market** - Undefined Market / Forming Market / an array of competing forms and models of understanding / Growing Market / consolidation to a few competing but more accepted forms / Mature Market / stabilised to an accepted form
- **market_action** - Gambling / driven by gut / Exploring a "found" value / Market analysis / listening to customers / Metric driven / build what is needed
- **market_perception** - Chaotic (non-linear) / domain of the "crazy" / Domain of "experts" / Increasing expectation of use / domain of "professionals" / Ordered (appearance of being linear) / trivial / formula to be applied
- **perception_in_industry** - Future source of competitive advantage / unpredictable / unknown / Seen as a scompetitive advantage / a differential / ROI / case examples / Advantage through implementation / features / this model is better than that / Cost of doing business / accepted / specific defined models
- **practice** - Novel / Emerging / Good / Best
- **publication** - Describe the wonder of the thing / the discovery of some marvel / a new land / an unknown frontier / Focused on build / construct / awareness and learning / many models of explanation / no accepted forms / a wild west / Maintenance / operations / installation / comparison between competing forms / feature analysis / Focused on use / increasingly an accepted, almost invisible component
- **ubiquity** - Rare / Slowly Increasing / Rapidly Increasing / Widespread in the applicable market / ecosystem
- **understanding** - Poorly Understood / unpredictable / Increasing understanding / development of measures / Increasing education / constant refinement of needs / measures / Believed to be well defined / stable / measurable
- **user_perception** - Different / confusing / exciting / surprising / dangerous / Leading edge / emerging / unceirtanty over results / Increasingly common / disappointed if not used or available / feeling left behind / Standard / expected / feeling of shock if not used
- **evolution_stage** - Stage I / Stage II / Stage III / Stage IV

# 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/