From 28c7c12db5d5669c5f69b29e5bc76ade81e2c710 Mon Sep 17 00:00:00 2001 From: Cas Cremers Date: Fri, 13 Dec 2013 22:33:10 +0000 Subject: [PATCH] More experiments with Markdown. --- README.md | 2 +- gui/INSTALL.md | 85 ++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 86 insertions(+), 1 deletion(-) create mode 100644 gui/INSTALL.md diff --git a/README.md b/README.md index 369bab3..7080127 100644 --- a/README.md +++ b/README.md @@ -53,7 +53,7 @@ Manual ------ We are currently rewriting the manual. The current (incomplete) snapshot -of the manual can be found here: +of the manual can be found in the following location: * [./gui/scyther-manual.pdf](gui/scyther-manual.pdf) diff --git a/gui/INSTALL.md b/gui/INSTALL.md new file mode 100644 index 0000000..abf5842 --- /dev/null +++ b/gui/INSTALL.md @@ -0,0 +1,85 @@ +Installation and usage of the Scyther tool +========================================== + +Requirements +------------ + +To be able to use Scyther, you need the following three things: + + +1. The GraphViz library. + + This library is used by the Scyther tool to draw graphs. It can be + freely downloaded from: + + http://www.graphviz.org/ + + Download the latest stable release and install it. + + + +The graphical user interface of Scyther is written in the Python +language. Therefore, the GUI requires the following two items: + + +2. Python + + Stable releases of the Python interpreter are available from: + + + + Scyther does not support Python 3. You are therefore recommended to + choose the latest production release of Python 2, e.g., Python 2.7. + + Mac OS X: + If the package yields an error when you try to install it, + please use the following, in the directory where you downloaded + it: + + $ sudo installer -pkg graphviz-2.34.0.pkg -target / + + +3. wxPython libraries. + + The GUI user interface uses the wxPython libraries. + + + + There are many different wxPython packages. You should choose a 32-bit + package that matches your Python version (e.g., 2.7). It is + recommended to select the unicode version from the stable releases. + + As of writing (May 2013) the following links lead to the appropriate + wxPython packages for Python 2.7: + + Windows: + + + Mac OS X: + + + Note that this package is in an old format and you will probably + get a warning "Package is damaged". This can be resolved by: + + $ sudo installer -pkg /Volume/.../wxPython2.8-osx-unicode-universal-py2.7.pkg/ -target / + + Ubuntu/Debian Linux: + + + +Running Scyther +--------------- + + +Start Scyther by executing the file + + scyther-gui.py + +in the directory where you found this file. + + Mac OS X: + + Right-click the file 'scyther-gui.py' and select "Open with" and + then "Python Launcher". + +