Commit f24ce0c6 authored by René de Hesselle's avatar René de Hesselle
Browse files

Update documentation

Add configuration and contact instructions.
parent 2957487c
Pipeline #408149230 passed with stages
in 32 minutes and 41 seconds
......@@ -4,14 +4,49 @@
![zim](zim.png)
This is [Zim](https://zim-wiki.org), packaged as native application bundle for macOS. It is completely standalone, relocatable and runs on OS X El Capitan 10.11 up to macOS Big Sur 11.
This is [Zim](https://zim-wiki.org), packaged as native application bundle for macOS. It is completely standalone, relocatable and runs on OS X El Capitan up to macOS Big Sur. It _should_ work on Monterey, but no promises yet. Rosetta 2 is required when running on ARM architecture.
## 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.
## license
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).
### credits
### additional credits
Built using other people's work:
......
zim.png

453 KB | W: | H:

zim.png

155 KB | W: | H:

zim.png
zim.png
zim.png
zim.png
  • 2-up
  • Swipe
  • Onion skin
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment