blob: d3818a8cdf7f34db83ce0a6029bd8fb58e7b93ee (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
|
# Map for Linux
A wardley mapping tool: Write some text, get a diagram
## Building
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`
## Formatting and Linting
* To format: `make format`
* To lint: `make lint`
## 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:
* `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
* `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
### 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 package-flatpak`.
The project assumes `flatpak-cargo-generator.py` lives in
`~/projects/vendor/flatpak-builder-tools/cargo`, but you can override this with
the environment variable `flatpak_cargo_generator` (eg.
`make -e flatpak_cargo_generator=~/your/path/to/flatpak_cargo_generator`). It
expects this directory to have the poetry configuration, as it enables the
virtualenv using poetry.
## Localization / Internationalization
This project uses gettext for translations. You can update the template files
with:
```
make extract_strings
```
This updates the available POTFILES by checking for the presence of the tr!
macro or `gettext`, and extracts the strings to the template file.
You can then edit the strings using a tool like Poedit.
## The wmap language
Learn more about the language at [map.tranquil.systems][map].
[map]: https://map.tranquil.systems/wmap-language
|
