README.md
1## Heimer
2
3Heimer is a desktop application for creating mind maps and other suitable diagrams. It's written in Qt and targeted for Linux and Windows.
4
5Here is a simple mind map of Heimer itself running on Ubuntu 18.04:
6
7
8
9<a href="https://www.youtube.com/watch?feature=player_embedded&v=NXJp6tmmZdE">A very short introduction video to Heimer 1.9.0</a>
10
11## Features
12
13* Adjustable grid
14* <a href="https://www.youtube.com/watch?feature=player_embedded&v=acQ8CpaCayk">Automatic layout optimization</a>
15* Autosave
16* Easy-to-use UI
17* Export to PNG or SVG
18* Forever 100% free
19* Full undo/redo
20* Nice animations
21* Quickly add node text and edge labels
22* Save/load in XML-based .ALZ-files
23* Translations in English (default), Chinese, Dutch, Finnish, French, Italian, Spanish
24* Very fast
25* Zoom in/out/fit
26* Zoom with mouse wheel
27
28## Donations
29
30It takes a lot of effort to develop and maintain Heimer, so if you find the application useful it would be very much appreciated to tip the project and help to keep the development active.
31
32It's easy to donate via PayPal:
33
34<a href="https://paypal.me/pools/c/8yvW5nEMmq">paypal.me/pools/c/8yvW5nEMmq</a>
35
36Thanks! :)
37
38## License
39
40Heimer's source code is licensed under GNU GPLv3.
41See COPYING for the complete license text.
42
43All image files, except where otherwise noted, are licensed under
44CC BY-SA 3.0: http://creativecommons.org/licenses/by-sa/3.0/
45
46## Installation
47
48See https://github.com/juzzlin/Heimer/releases for available pre-built packages.
49
50### Linux: Snap
51
52On Linux distributions that support universal Snap packages you can install Heimer like this:
53
54`$ snap install heimer`
55
56For more information see https://snapcraft.io/heimer and https://docs.snapcraft.io/core/install
57
58Snap is the recommended way to install Heimer on Linux.
59
60### Linux: Deb
61
62There are Debian packages for Ubuntu/Debian. Use some graphical tool to install, or as an example on `Ubuntu 20.04`:
63
64`$ sudo apt install ./heimer-2.5.0-ubuntu-20.04_amd64.deb`
65
66### Linux: AppImage
67
68`AppImage` is a "universal" package that can (in theory) be run on all Linux platforms:
69
70Make the image executable e.g. like this:
71
72`$ chmod 755 Heimer-2.4.0-x86_64.AppImage`
73
74Run:
75
76`$ ./Heimer-2.4.0-x86_64.AppImage`
77
78### Windows
79
80For Windows there's an installer and alternatively a ZIP-archive that just contains the Heimer executable.
81
82## Building the project
83
84Currently the build depends on `Qt 5` only (`qt5-default`, `qttools5-dev-tools`, `qttools5-dev`, `libqt5svg5-dev` packages on Ubuntu). Support for `Qt 6` is preliminary and should work with `CMake`.
85
86### Linux / Unix
87
88The "official" build system for Linux is `CMake`.
89
90Building for Linux in a nutshell:
91
92`$ mkdir build && cd build`
93
94`$ cmake ..`
95
96`$ make -j4`
97
98Run unit tests:
99
100`$ ctest`
101
102Install locally:
103
104`$ sudo make install`
105
106Debian package (`.deb`) can be created like this:
107
108`$ cpack -G DEB`
109
110See `Jenkinsfile` on how to build other packages in Docker.
111
112### Windows
113
114The NSIS installer for Windows is currently built in Docker with MXE (http://mxe.cc):
115
116`$ ./scripts/build-windows-nsis`
117
118This is so very cool! A Windowsless Windows build!
119
120Anyway, as the project depends only on Qt SDK you can use your favourite Qt setup to build the project on Windows.
121
122### Docker environments
123
124Needed Dockerfiles can be found at https://github.com/juzzlin/Dockerfiles
125
126
