README.md 2.29 KB
Newer Older
René de Hesselle's avatar
René de Hesselle committed
1
2
# Zim for macOS

René de Hesselle's avatar
René de Hesselle committed
3
4
![GitLab master branch](https://gitlab.com/dehesselle/zim_macos/badges/master/pipeline.svg)

René de Hesselle's avatar
René de Hesselle committed
5
![zim](zim.png)
René de Hesselle's avatar
René de Hesselle committed
6

René de Hesselle's avatar
René de Hesselle committed
7
This is the official macOS release for [Zim](https://zim-wiki.org). The app is completely standalone, relocatable and runs on OS X El Capitan up to macOS Monterey. Rosetta 2 is required when running on ARM architecture.
René de Hesselle's avatar
René de Hesselle committed
8

9
10
11
12
## download

Downloads are available in the [Releases](https://gitlab.com/dehesselle/zim_macos/-/releases) section.

René de Hesselle's avatar
René de Hesselle committed
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
## configuration

The following locations are being used:

| type | path |
| --- | --- |
| configuration files | `~/Library/Application Support/org.zim-wiki.Zim` |
| cache files | `~/Library/Caches/org.zim-wiki.Zim` |
| runtime files | `/tmp` |

### advanced

💁 _Incorrect usage of the following can break the app - you have been warned!_

Specific to the macOS app, you can create a file named `zimapp.ini` in the configuration files folder. You can modify the environment with the help of this file.

A common usage scenario is to modify `$PATH` so Zim can pick up dependencies that don't come bundled with the app. For example, to make the equation editor find Latex that you installed with Homebrew (assuming default installation prefix `/usr/local` and that you didn't remove that from your `$PATH`), add the following:

```ini
[environment]
# Important:
#   - replace <default PATH> with the full output from 'echo $PATH'
#   - always include the path to the app's Resources/bin folder
PATH=<default PATH>:/Applications/Zim.app/Contents/Resources/bin
```

It is important to understand that

- setting an environment variable overrides any default/automatic configuration of that variable. (This is why you can easily break things here.)
- there is no variable resolution. (This is not a shell.)

## contact

Please visit Zim's [repository on GitHub](https://github.com/zim-desktop-wiki/zim-desktop-wiki) or [website](https://zim-wiki.org) for all your needs.
René de Hesselle's avatar
René de Hesselle committed
47

René de Hesselle's avatar
René de Hesselle committed
48
## license
49

René de Hesselle's avatar
René de Hesselle committed
50
51
This work is licensed under [GPL-2.0-or-later](LICENSE).  
Zim is licensed under [GPL-2.0-or-later](https://github.com/zim-desktop-wiki/zim-desktop-wiki#copyright-and-license).
52

René de Hesselle's avatar
René de Hesselle committed
53
### additional credits
54

René de Hesselle's avatar
René de Hesselle committed
55
Built using other people's work:
René de Hesselle's avatar
René de Hesselle committed
56

René de Hesselle's avatar
René de Hesselle committed
57
58
- [gtk-osx](https://gitlab.gnome.org/GNOME/gtk-osx) licensed under GPL-2.0-or-later.
- [Leksys' INIParser](https://github.com/Lek-sys/LeksysINI]) licensed under MIT.