From d07882b21f5e68b84469a6bf94ce20b06a09a3fa Mon Sep 17 00:00:00 2001 From: Ruben Beltran del Rio Date: Wed, 17 Dec 2025 00:07:48 +0100 Subject: Initial implementation --- README.md | 33 +++++++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) create mode 100644 README.md (limited to 'README.md') diff --git a/README.md b/README.md new file mode 100644 index 0000000..4925f2e --- /dev/null +++ b/README.md @@ -0,0 +1,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/ -- cgit