From 17bf89fb876b8ba7a35d06feec93125cd65f5f71 Mon Sep 17 00:00:00 2001 From: Aleks Kissinger Date: Mon, 9 Apr 2018 12:02:23 +0200 Subject: updated README --- README.md | 27 +++++++++++++++++++++------ 1 file changed, 21 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 57a7255..09835a7 100644 --- a/README.md +++ b/README.md @@ -5,11 +5,20 @@ TikZiT is a graphical tool for rapidly creating graphs and diagrams using PGF/Ti ## Building on Windows -TODO +TiKZiT can be built in Windows using Qt Creator (part of Qt for Windows) or Visual Studio with the Qt VS Tools extension. + +To build with Qt Creator, simply click 'Open Project' and navigate to the `.pro` file in the TikZiT repo. + +To install Qt VS Tools in Visual Studio 2017, go to `Tools > Extensions and Updates`, then click "Online" in the sidebar and search for Qt. Configure your Qt install under `Qt VS Tools > Qt Options`. If you installed Qt using the Windows package above, the path to Qt is probably something like `C:\Qt\5.XXX\msvc2017_64`. Once that is done, open the `.pro` file in the TikZiT repo via `Qt VS Tools > Open Qt Project File`. ## Building on Linux -TODO +This should be buildable in Linux using a "standard" dev setup (gcc, flex, bison, make). You will also need to configure Qt (instructions for Ubuntu are here). After that, building is: + + $ qmake + $ make + + ## Building on MacOS @@ -21,12 +30,18 @@ This doesn't add Qt binaries to the PATH by default, so you may wish to add this export PATH="/usr/local/opt/qt/bin:$PATH" +Then, TikZiT is built just like a normal Qt project: + + $ qmake + $ make + + +## Building Poppler with Qt bindings + +Although TikZiT doesn't currently support PDF preview, it probably will in the near future via Poppler. Here's the instructions for building it as a developer. + Poppler should be built from source to get the Qt5 bindings. If Qt is setup correctly, the configure script included with Poppler should enable these automatically. Also, note that clang needs to have C++11 features enabled to build successfully. TikZiT has been tested on MacOS with poppler-0.50.0 (available here), built with the following commands: $ CXXFLAGS="-std=c++11" ./configure $ CXXFLAGS="-std=c++11" make -Then, TikZiT is built just like a normal Qt project: - - $ qmake - $ make -- cgit v1.2.3