diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 39 |
1 files changed, 32 insertions, 7 deletions
@@ -6,6 +6,15 @@ A wardley mapping tool: Write some text, get a diagram Run `make build` +## Installing + +For a quick local install without packaging: + +* `make install` - installs to `/usr/local` (may require sudo) +* `make uninstall` - removes installed files + +To install to a different prefix: `make install prefix=/opt/map` + ## Testing Run `make test` @@ -15,18 +24,34 @@ Run `make test` * To format: `make format` * To lint: `make lint` -## Disributing +## Distributing + +Available package formats: deb, rpm, tar.gz, flatpak + +### Main Targets + +* `make package` - creates all package types for the current architecture (no upload) +* `make distribute` - signs and uploads existing packages +* `make release` - full workflow (package + distribute) + +### Individual Targets + +For more control, use individual package or distribute targets: -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. +* `make package-deb` - create .deb package +* `make package-rpm` - create .rpm package +* `make package-tar` - create .tar.gz archive +* `make package-flatpak` - create .flatpak bundle -### Flatpak +* `make distribute-deb` - sign and upload .deb +* `make distribute-rpm` - sign and upload .rpm +* `make distribute-tar` - sign and upload .tar.gz +* `make distribute-flatpak` - sign and upload .flatpak -Build it with `make flatpak` +### Flatpak Notes Since flatpak expects offline building, we use `flatpak-cargo-generator` to -generate the sources. This will be done every time you run `make flatpak`. +generate the sources. This will be done every time you run `make package-flatpak`. The project assumes `flatpak-cargo-generator.py` lives in `~/projects/vendor/flatpak-builder-tools/cargo`, but you can override this with |