From d79135fd069578ffdc02459e959e41054f373bc4 Mon Sep 17 00:00:00 2001 From: Cas Cremers Date: Fri, 13 Dec 2013 22:47:47 +0000 Subject: [PATCH] Updated installation markdown file. --- gui/INSTALL.md | 62 ++++++++++++++++++++++++++----------------------- gui/INSTALL.txt | 19 +++++++-------- 2 files changed, 41 insertions(+), 40 deletions(-) diff --git a/gui/INSTALL.md b/gui/INSTALL.md index abf5842..5ef065d 100644 --- a/gui/INSTALL.md +++ b/gui/INSTALL.md @@ -4,8 +4,9 @@ Installation and usage of the Scyther tool Requirements ------------ -To be able to use Scyther, you need the following three things: - +To be able to use all of Scyther's features, the following three +dependencies are needed. If you only require the back-end tool (used +from the command line) then you need only the first. 1. The GraphViz library. @@ -17,33 +18,31 @@ To be able to use Scyther, you need the following three things: 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: - + http://www.python.org/download/ 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 / + * 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. - + http://www.wxpython.org/download.php There are many different wxPython packages. You should choose a 32-bit package that matches your Python version (e.g., 2.7). It is @@ -52,19 +51,24 @@ language. Therefore, the GUI requires the following two items: As of writing (May 2013) the following links lead to the appropriate wxPython packages for Python 2.7: - Windows: - + * Windows: + + http://downloads.sourceforge.net/wxpython/wxPython2.8-win32-unicode-2.8.12.1-py27.exe - Mac OS X: - + * Mac OS X: + + http://downloads.sourceforge.net/wxpython/wxPython2.8-osx-unicode-2.8.12.1-universal-py2.7.dmg - 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 / + 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: - + * Ubuntu/Debian Linux: + + http://wiki.wxpython.org/InstallingOnUbuntuOrDebian Running Scyther @@ -75,11 +79,11 @@ Start Scyther by executing the file scyther-gui.py -in the directory where you found this file. +in the main directory of the extracted archive. - Mac OS X: + * Mac OS X: - Right-click the file 'scyther-gui.py' and select "Open with" and - then "Python Launcher". + Right-click the file 'scyther-gui.py' and select "Open with" and + then "Python Launcher". diff --git a/gui/INSTALL.txt b/gui/INSTALL.txt index 37d959b..abf5842 100644 --- a/gui/INSTALL.txt +++ b/gui/INSTALL.txt @@ -1,10 +1,8 @@ -======================================================================== Installation and usage of the Scyther tool -======================================================================== +========================================== ------------------------------------------------------------------------- Requirements ------------------------------------------------------------------------- +------------ To be able to use Scyther, you need the following three things: @@ -28,7 +26,7 @@ language. Therefore, the GUI requires the following two items: Stable releases of the Python interpreter are available from: - http://www.python.org/download/ + Scyther does not support Python 3. You are therefore recommended to choose the latest production release of Python 2, e.g., Python 2.7. @@ -45,7 +43,7 @@ language. Therefore, the GUI requires the following two items: The GUI user interface uses the wxPython libraries. - http://www.wxpython.org/download.php + There are many different wxPython packages. You should choose a 32-bit package that matches your Python version (e.g., 2.7). It is @@ -55,10 +53,10 @@ language. Therefore, the GUI requires the following two items: wxPython packages for Python 2.7: Windows: - http://downloads.sourceforge.net/wxpython/wxPython2.8-win32-unicode-2.8.12.1-py27.exe + Mac OS X: - http://downloads.sourceforge.net/wxpython/wxPython2.8-osx-unicode-2.8.12.1-universal-py2.7.dmg + Note that this package is in an old format and you will probably get a warning "Package is damaged". This can be resolved by: @@ -66,12 +64,11 @@ language. Therefore, the GUI requires the following two items: $ sudo installer -pkg /Volume/.../wxPython2.8-osx-unicode-universal-py2.7.pkg/ -target / Ubuntu/Debian Linux: - http://wiki.wxpython.org/InstallingOnUbuntuOrDebian + ------------------------------------------------------------------------- Running Scyther ------------------------------------------------------------------------- +--------------- Start Scyther by executing the file