aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorRubén Beltrán del Río <jj@r.bdr.sh>2025-12-26 21:17:05 +0100
committerRubén Beltrán del Río <jj@r.bdr.sh>2025-12-26 21:25:41 +0100
commit5cb79e3f86b5328301eabbbc409f254b58ee9bf4 (patch)
tree78d48265bc840b4e7564ed38b3ba9a3026001fdb /README.md
Initial build
Diffstat (limited to 'README.md')
-rw-r--r--README.md28
1 files changed, 28 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..8e87e71
--- /dev/null
+++ b/README.md
@@ -0,0 +1,28 @@
+# Map for Linux
+
+A wardley mapping tool: Write some text, get a diagram
+
+## Building
+
+Run `make build`
+
+## Testing
+
+Run `make test`
+
+## Formatting and Linting
+
+* To format: `make format`
+* To lint: `make lint`
+
+## Disributing
+
+Not yet complete. The current `make distribute` will make a deb and rpm, but is
+missing desktop files and potentially more desktop friendly distributions like
+flatpak.
+
+## The wmap language
+
+Learn more about the language at [map.tranquil.systems][map].
+
+[map]: https://map.tranquil.systems/wmap-language