Skip to content

README.md

Latest commit

 

History

History
47 lines (39 loc) · 1.37 KB

README.md

File metadata and controls

47 lines (39 loc) · 1.37 KB

BitPresent

A presentation engine, that creates a PDF from a markdown styled input file

Installation

Installation is straight forward, just download the package you need from the releases and either extract the folder or run the installer if you are on Windows.

Important! Make sure to have a folder called ".cache" for Linux or "cache" for Windows in the installation folder. If not, the program will crash. For Linux you can check by using following commands in the terminal:

cd path/to/bitPresent/installation
ls -a

Usage:

See the documentation in the docs folder here or just follow this link: https://github.com/BitTim/BitPresent/blob/master/docs/BitPresent%20-%20Documentation.pdf

Compiling

Linux:

Make sure to have following installed:

  • gcc
  • libsdl2 (libsdl2-dev on Ubuntu based)
  • libsdl2-ttf (libsdl2-ttf-dev on Ubuntu based)
  • libsdl2-image (libsdl2-image-dev on Ubuntu based)
  • libharu
  • wxgtk3 (or wxwidgets in general)

And their dependencies. After that, run following commands:

git clone https://github.com/bittim/bitpresent/BitPresent
cd BitPresent/Linux/
make init
make

Windows:

Install Visual Studio and vcpkg. Install following through vcpkg:

  • sdl2
  • sdl2-ttf
  • sdl2-image
  • sdl2-image[libjpeg-turbo]
  • sdl2-image[libwebp]
  • libharu
  • wxwidgets

Open the project, which is located in the Windows folder, in Visual Studio and build