Permalink
Switch branches/tags
Nothing to show
Find file Copy path
7648d9c Sep 23, 2018
2 contributors

Users who have contributed to this file

@dvorka @chabad360
488 lines (358 sloc) 13.3 KB

Installation

Install:

Build:

Docker:

Tarball:

Unfortunately links above must have trailing '-' to workaround GitHub MD to HTML rendering bug. Therefore these links are broken in Markdown editors (including MF).

Install a package

Install MindForger using a package.

Ubuntu

Install MindForger from PPA. Add my Lauchpad hosted PPA and install MindForger:

# add PPA to trusted repositories
sudo add-apt-repository ppa:ultradvorka/productivity

# update sources
sudo apt update

# install MindForger
sudo apt install mindforger

Debian

Install MindForger from PPA. Add my PPA, trust GPG key and install MindForger:

# add PPA to APT sources:
sudo echo -e "\ndeb http://www.mindforger.com/debian stretch main" >> /etc/apt/sources.list

# import PPA's GPG key
wget -qO - http://www.mindforger.com/gpgpubkey.txt | sudo apt-key add -

# update sources
sudo apt update

# install MindForger
sudo apt install mindforger

See also http://www.mindforger.com/debian/

Fedora

Install MindForger on Fedora (tested on FC 27):

Install RPM:

sudo dnf install mindforger-MAJOR.MINOR.REVISION.rpm

Arch Linux

Install MindForger from Arch User Repository (AUR):

macOS

Install MindForger on macOS (tested on Sierra 10.12):

Install .dmg:

  • Open/mount .dmg
  • Drag and drop/copy mindforger from .dmg to Applications
  • Run MindForger

MindForger creates copy of the documentation in your home directory (~/mindforger-repository) and opens it as default repository.

WSL

Install Windows Subsystem for Linux (WSL) and check that you have Ubuntu 16.04 or newer:

lsb_release -a
  ...
  Release:        16.04
  Codename:       xenial

If not, then run sudo do-release-upgrade.

Install and start an X server for Windows like Xming.


Install MindForger from PPA. Add my PPA to Apt, trust GPG key, install MindForger and run it:

# add PPA to trusted repositories
sudo add-apt-repository ppa:ultradvorka/productivity

# update sources
sudo apt update

# install MindForger
sudo apt install mindforger

# run MindForger
DISPLAY=:0.0 mindforger

Build from source code

Build MindForger from source code.

Build on Ubuntu

Build MindForger on Ubuntu 16.04 or later.

Install build tools:

sudo apt-get install build-essential zlib1g-dev libqt5webkit5-dev qttools5-dev-tools qt5-default ccache

Get source code:

# clone MindForger repository
git clone https://github.com/dvorka/mindforger.git
# update repository sub-modules
cd mindforger
git submodule init
git submodule update

Build dependencies:

# build Discount
cd deps/discount
./configure.sh
make

Compile and install from Git repository root directory:

qmake -r mindforger.pro
# consider speeding up compilation by increasing the number of CPU cores to use e.g. make -j8
make
sudo make install

Install documentation and stencils:

# clone MindForger documentation repository to home directory (location and directory name matters)
cd ~
git clone https://github.com/dvorka/mindforger-repository.git

# verify MindForger repository installation
ls mindforger-repository
  limbo  memory  mind  stencils

Run MindForger:

mindforger

Build on Debian

Build MindForger on Debian Stretch or later.

Install build tools:

sudo apt-get install build-essential zlib1g-dev libqt5webkit5-dev qttools5-dev-tools qt5-default ccache

Get source code:

# clone MindForger repository
git clone https://github.com/dvorka/mindforger.git
# update repository sub-modules
git submodule init
git submodule update

Build dependencies:

# build Discount
cd deps/discount
./configure.sh
make

Compile and install from Git repository root directory:

qmake -r mindforger.pro
# consider speeding up compilation by increasing the number of CPU cores to use e.g. make -j8
make
sudo make install

Install documentation and stencils:

# clone MindForger documentation repository to home directory (location and directory name matters)
cd ~
git clone https://github.com/dvorka/mindforger-repository.git

# verify MindForger repository installation
ls mindforger-repository
  limbo  memory  mind  stencils

Run MindForger:

mindforger

Build on Fedora

Build MindForger on Fedora.

Install build tools:

sudo dnf install zlib-devel qt-devel qt5-devel ccache

Get source code:

# clone MindForger repository
git clone https://github.com/dvorka/mindforger.git
# update repository sub-modules                                            
git submodule init
git submodule update

Build dependencies:

# build Discount
cd deps/discount
./configure.sh
make

Compile and install from Git repository root directory:

qmake-qt5 -r mindforger.pro
# consider speeding up compilation by increasing the number of CPU cores to use e.g. make -j8
make
sudo make install

Install documentation and stencils:

# clone MindForger documentation repository to home directory (location and directory name matters)
cd ~
git clone https://github.com/dvorka/mindforger-repository.git

# verify MindForger repository installation
ls mindforger-repository
  limbo  memory  mind  stencils

Run MindForger:

mindforger

Build on macOS

Build MindForger on macOS Sierra 10.12+.

Open Terminal and install Xcode command line tools:

xcode-select --install

Install Homebrew package manager:

ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
brew doctor

Install build tools and dependencies:

brew install ccache qt

Add them to PATH (if they already not present):

# add newly installed deps to path
echo 'export PATH="/usr/local/bin:$PATH"' >> ~/.bashr_profile
echo 'export PATH="/usr/local/opt/qt/bin:$PATH"' >> ~/.bashr_profile

# apply changes
. ~/.bash_profile

Get source code:

git clone https://github.com/dvorka/mindforger.git
git submodule init
git submodule update

Build dependencies:

# build Discount
cd mindforger/deps/discount
./configure.sh
make

Compile MindForger from Git repository root directory:

qmake -r mindforger.pro
# consider adding -j parameter with the number of CPU cores to use e.g. make -j 8
make

Optionally install MindForger:

cd app && cp -rvf mindforger.app /Applications

Install documentation and stencils:

# clone MindForger documentation repository to home directory - location and directory name matters
cd ~
git clone https://github.com/dvorka/mindforger-repository.git

# verify MindForger repository installation
ls ~/mindforger-repository
  limbo  memory  mind  stencils

Run MindForger either as application or using command line:

/Applications/mindforger.app/contents/MacOS/mindforger

IMPORTANT: in case that there is a problem with HTML preview ~ nothing is shown for a note:

  • uinstall Qt installed using brew (brew remove qt)
  • install Qt from https://www.qt.io/download
  • use qmake from the official distribution to build MindForger (as described above)

Brew approach is simpler, faster and usually works - this is why it is used by default.

Build on WSL

Build MindForger on Windows Subsystem for Linux (WSL).

Install build tools:

sudo apt-get install build-essential zlib1g-dev libqt5webkit5-dev qttools5-dev-tools qt5-default ccache

Update gcc and g++ to version 5 (at least):

# adds the the test toolchain which includes gcc-5 and g++5 
sudo add-apt-repository ppa:ubuntu-toolchain-r/test
sudo apt-get update
sudo apt-get install gcc-5 g++-5
# substitute gcc-5 for gcc and g++-5 for g++ (current version)
sudo update-alternatives --install /usr/bin/gcc gcc /usr/bin/gcc-5 60 --slave /usr/bin/g++ g++ /usr/bin/g++-5

Get source code:

# clone MindForger repository
git clone https://github.com/dvorka/mindforger.git
# update repository sub-modules
cd mindforger
git submodule init
git submodule update

Build dependencies:

# build Discount
cd deps/discount
./configure.sh
make

Compile and install from Git repository root directory:

qmake -r mindforger.pro
# consider speeding up compilation by increasing the number of CPU cores to use e.g. make -j8
make
sudo make install

Install documentation and stencils:

# clone MindForger documentation repository to home directory (location and directory name matters)
cd ~
git clone https://github.com/dvorka/mindforger-repository.git

# verify MindForger repository installation
ls mindforger-repository
  limbo  memory  mind  stencils

Run MindForger and start your XServer for Windows (e.g. Xming)

DISPLAY=:0.0 mindforger

Docker

Run MindForger in Docker container.

Build and run in container

Build Docker image and run MindForger in Docker container.

Build image:

mkdir mindforger

# download Dockerfile
curl https://raw.githubusercontent.com/dvorka/mindforger/master/build/docker/mindforger/Dockerfile > mindforger/Dockerfile

# build image
docker build -t mindforger:latest mindforger

Run container:

# allow access to X server (UNSECURE, but simple):
xhost +local:root

# run image
docker run -it --env="DISPLAY" --env="QT_X11_NO_MITSHM=1" \
    --volume="/tmp/.X11-unix:/tmp/.X11-unix:rw" mindforger:latest mindforger

# determine and remember container ID
docker ps -l -q > ~/.mindforger.docker

Run MindForger by starting container:

# start (stopped) container
docker start $(cat ~/.mindforger.docker)

Check also https://github.com/dvorka/mindforger/tree/master/build/docker for handy scripts.