aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: 34a5b687c3b8b0df3f0b52f51e68129d4d9d293e (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
# 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.

### Flatpak

Build it with `make flatpak`

Since flatpak expects offline building, we use `flatpak-cargo-generator` to
generate the sources. This will be done every time you run `make 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