README.md
1# Minder
2
3<p align="center">
4 <a href="https://appcenter.elementary.io/com.github.phase1geo.minder"><img src="https://appcenter.elementary.io/badge.svg" alt="Get it on AppCenter" /></a>
5</p>
6
7![<center><b>Main Window - Light Theme</b></center>](https://raw.githubusercontent.com/phase1geo/Minder/master/data/screenshots/screenshot-current-properties.png "Mind-mapping application for Elementary OS")
8
9## Overview
10
11Use the power of mind-mapping to make your ideas come to life.
12
13- Quickly create visual mind-maps using the keyboard and automatic layout.
14- Choose from many tree layout choices.
15- Support for Markdown formatting.
16- Add notes, tasks and images to your nodes.
17- Add node-to-node connections with optional text and notes.
18- Stylize nodes, links and connections to add more meaning and improve readability.
19- Add stickers and node groups to call out and visibly organize information.
20- Quick search of node and connection titles and notes, including filtering options.
21- Zoom in or enable focus mode to focus on certain ideas or zoom out to see the bigger picture.
22- Enter focus mode to better view and understand portions of the map.
23- Unlimited undo/redo of any change.
24- Automatically saves in the background.
25- Colorized node branches.
26- Open multiple mindmaps with the use of tabs.
27- Built-in and customizable theming.
28- Gorgeous animations.
29- Import from OPML, FreeMind, Freeplane, PlainText (formatted), Outliner, Portable Minder and XMind formats.
30- Export to CSV, FreeMind, Freeplane, JPEG, BMP, SVG, Markdown, Mermaid, OPML, Org-Mode, Outliner, PDF, PNG, Portable Minder, PlainText, XMind and yEd formats.
31- Printer support.
32
33## Installation
34
35You will need the following dependencies to build Minder:
36
37* ninja-build
38* python3-pip
39* python3-setuptools
40* meson
41* valac (any 0.48.x version -- any later version will result in segfaults -- earlier versions have issues with libarchive)
42* debhelper
43* libcairo2-dev
44* libgranite-dev
45* libgtk-3-dev
46* libxml2-dev
47* libgee-0.8-dev
48* libarchive-dev
49* libgtksourceview-4-dev
50* libmarkdown2-dev
51
52To install, run `sudo ./app install` and then run the application from your application launcher or from
53the command-line with `./app run`.
54
55## Distribution packages
56
57Arch Linux users can find Minder in the official `community` repo:
58
59`$ sudo pacman -S minder`
60
61Minder is packaged in Void Linux, install it with `xbps-install`:
62
63`$ sudo xbps-install Minder`
64
65For Fedora users, install the RPM package with:
66
67`$ sudo dnf install minder`
68
69Debian/Ubuntu package is also available:
70
71`$ sudo apt install minder`
72
73## Documentation
74
75Minder documentation can be found [here](https://github.com/phase1geo/Minder/wiki/Table-of-Contents).
76
77<p align="center">
78 <a href="https://appcenter.elementary.io/com.github.phase1geo.minder"><img src="https://appcenter.elementary.io/badge.svg" alt="Get it on AppCenter" /></a>
79</p>
80