From 1382f4fc322aeda453fd4ae4f5eceeeb47fcddfb Mon Sep 17 00:00:00 2001 From: Aleks Kissinger Date: Thu, 4 Jan 2018 16:13:00 +0100 Subject: updated readme --- README | 12 ------------ README.md | 26 +++++++++++++++++++++++++- 2 files changed, 25 insertions(+), 13 deletions(-) delete mode 100644 README diff --git a/README b/README deleted file mode 100644 index ecd6713..0000000 --- a/README +++ /dev/null @@ -1,12 +0,0 @@ -Building on OSX: - -You'll need QT5 and poppler with QT5 bindings. QT5 can be installed with Homebrew: - -$ brew install qt5 - -whereas poppler should be built from source to get the QT5 bindings. To compile, clang needs to have C++11 features enabled. I built using: - -$ CXXFLAGS="-std=c++11" ./configure -$ CXXFLAGS="-std=c++11" make - - diff --git a/README.md b/README.md index a8e8b64..a237b88 100644 --- a/README.md +++ b/README.md @@ -1 +1,25 @@ -TikZiT is a graphical tool for rapidly creating an editing node-and-edge style graphs. It was originally created to aid in the typesetting of "dot" diagrams of interacting quantum observables (see arXiv:0906.4725), but can be used as a general graph editing program. Click one of the above icons to download. To comment or contribute, email me at gmail.com preceded by aleks0 and an at-sign. \ No newline at end of file + +# TikZiT + +TikZiT is a graphical tool for rapidly creating graphs and diagrams using PGF/TikZ. It was used, for example, to make all of the 2500+ diagrams in this book. It is currently undergoing a port to Qt5 for better cross-platform support. As such, the code on this branch, and the README is a work in progress. + +## Building on Windows + +TODO + +## Building on Linux + +TODO + +## Building on MacOS + +You'll need Qt5 and poppler with Qt5 bindings. Qt5 can be installed using e.g. Homebrew, as follows: + + $ brew install qt5 + +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 + + -- cgit v1.2.3