Merge branch 'master' of /home/cas/Dropbox/repos/scyther

This commit is contained in:
Cas Cremers 2013-12-23 13:12:03 +00:00
commit 1a9a8714a6
4 changed files with 111 additions and 18 deletions

View File

@ -53,9 +53,9 @@ 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](gui/scyther-manual.pdf)
Protocol Models
@ -63,8 +63,8 @@ Protocol Models
The protocol models have the extension `.spdl` and can be found in the following directories:
* `./gui/Protocols`, containing the officially released models, and
* `./testing`, containing models currently under development.
* [./gui/Protocols](gui/Protocols), containing the officially released models, and
* [./testing](testing), containing models currently under development.
License
-------

96
gui/INSTALL.md Normal file
View File

@ -0,0 +1,96 @@
Installation and usage of the Scyther tool
==========================================
Download
--------
Downloads of binary archives of Scyther for all main platforms can be
found at http://users.ox.ac.uk/~coml0529/scyther/index.html
Requirements
------------
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 ###
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.
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 /
```
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
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**
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:
```
$ sudo installer -pkg /Volume/.../wxPython2.8-osx-unicode-universal-py2.7.pkg/ -target /
```
* **Ubuntu/Debian Linux**
http://wiki.wxpython.org/InstallingOnUbuntuOrDebian
Running Scyther
---------------
Extract the Scyther archive and navigate to the extracted directory.
Start Scyther by executing the file
scyther-gui.py
in the main directory of the extracted archive.
* **Mac OS X**
Right-click the file 'scyther-gui.py' and select "Open with" and
then "Python Launcher".

View File

@ -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/
<a href="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
<a href="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
<a href="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
<a href="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
<a href="http://wiki.wxpython.org/InstallingOnUbuntuOrDebian">
------------------------------------------------------------------------
Running Scyther
------------------------------------------------------------------------
---------------
Start Scyther by executing the file

View File

@ -7,7 +7,7 @@ developed by Cas Cremers, and is available from
The below instructions apply only to the *distribution version* of
the Scyther tool. If you are working from the source files, some paths may be
slightly different, and it is recommended to follow the instructions in '../README.md'.
slightly different, and it is recommended to follow the instructions in [../README.md](../README.md).
Running the scyther tool
------------------------
@ -48,7 +48,7 @@ Manual
We are currently rewriting the manual. The current (incomplete)
distribution version of the manual can be found here:
* `./scyther-manual.pdf`
* [./scyther-manual.pdf](scyther-manual.pdf)
Protocol Models
@ -56,7 +56,7 @@ Protocol Models
The protocol models have the extension `.spdl` and can be found in the following directories:
* `./Protocols` and its subdirectories.
* [./Protocols](Protocols) and its subdirectories.
License
-------