aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md9
1 files changed, 9 insertions, 0 deletions
diff --git a/README.md b/README.md
index 3296de2..7daaa1d 100644
--- a/README.md
+++ b/README.md
@@ -49,6 +49,15 @@ Run `just test`
`meson.build` is the source of truth for the version. To sync versions to
Cargo.toml, rpm spec, etc. use `just sync-versions`
+The convention in this project is to use directories starting with `_` for
+generated ones to distinguish them from the source more easily. They are all
+configurable via the justfile. The defaults are:
+
+- `_build`: The meson build directory.
+- `_dist`: The location where built distributable packages are placed.
+- `_repo`: The flatpak repo
+- `_flatpak`: The flatpak build directory
+
## Distributing
Available package formats: deb, rpm, tar.gz, flatpak.