Contribute

Building from source

On Github is the Source Code. To build it you need:

• C++ Compiler that supports C++20
• CMake 3.12 or later
• Qt5 Base and Svg
• KF5TextEditor and KF5SyntaxHighlighting
• Antlr4 Runtime

To run it you need:

• For the formula support: LaTeX
• If you want to edit your images with inkscape: inkscape
• Some nice looking fonts

If you have bugs or want to contribute, open a bug or merge request on Github.

Detailed description for building on Ubuntu

To build this project a few dependencies are needed. Also, it is possible that you have to install newer versions of stuff you already have.

G++11

First you need a C++ compiler that supports the C++20 standard e.g. the g++-11. For this you can use the PPA:

sudo add-apt-repository ppa:ubuntu-toolchain-r/test
sudo apt-get update
sudo apt install g++-11

CMake

On Ubuntu 20 you can use the CMake from the repository:

sudo apt-get install cmake

You need to have a CMake 3.12 minimum, so on Ubuntu 18 you have to install a newer one than in the repository. For this you can for example follow these instructions:

https://apt.kitware.com

Qt5.15

Additionally you need Qt5. If you have an older version of it, it can be that some used functions are missing. To get a newer one, again add the PPA:

ubuntu 18:
sudo add-apt-repository ppa:beineri/opt-qt-5.15.2-bionic

ubuntu 20:
sudo add-apt-repository ppa:beineri/opt-qt-5.15.0-focal

Then update and install:

sudo apt-get update && sudo apt-get install qt515base qt515svg qt515declarative

KTextEditor

To get the KTextEditor and the KSyntaxHiglighting, install the developer packages and additional gettext:

sudo apt-get install libkf5texteditor-dev libkf5syntaxhighlighting-dev gettext

Antlr4.9.3

You need uuid to build antlr4:

sudo apt-get install uuid-dev

To get the antlr4-runtime (the Parser Generator) download it and build it:

mkdir antlr4
cd antlr4
wget https://www.antlr.org/download/antlr4-cpp-runtime-4.9.3-source.zip && unzip antlr4-cpp-runtime-4.9.3-source.zip
env CXX=g++-11 cmake .  -DANTLR4_INSTALL=ON -DWITH_DEMO=False
sudo make install

Potato Presenter

Download the source code:

git clone https://github.com/thgier/PotatoPresenter.git

If you want to build a specific version, use git checkout, e.g.

git checkout v1.0.1

Make a build directory:

mkdir build
cd build

Run CMake and give it the right version of the compiler and of Qt5 and the directory where antlr4 has installed his .cmake files:

cmake -DCMAKE_PREFIX_PATH="/opt/qt515/lib/cmake;/usr/local/lib/cmake/antlr4/" -DCMAKE_CXX_COMPILER=g++-11 ..

And build it:

make

To run it, you have to give again the right Qt5 version:

env LD_LIBRARY_PATH=/opt/qt515/lib/ ./praes

For the LaTeX formulas, some additional packages are required. Install them with:

sudo apt-get install texlive-latex-extra texlive-fonts-extra texlive-science

Detailed description for building on Arch Linux

Install dependencies (if needed):

sudo pacman -Syu --needed cmake ktexteditor antlr4-runtime

clone git repository:

git clone https://github.com/thgier/PotatoPresenter.git
cd PotatoPresenter

generate build tree:

mkdir build
cd build
cmake ..

compile (use all cpu cores):

make -j$(nproc)

Run:

./PotatoPresenter

For the LaTeX formulas, some additional packages are required. Install them with:

sudo pacman -S texlive-latexextra texlive-fontsextra texlive-science

If you have problems with building, open an issue on Github. It would be nice if you help to improve these instructions.