- Improved documentation.

gui/INSTALL.txt

@@ -1,20 +1,94 @@
-- Linux/Windows
+1. Installation
-
+========================================================================
-  Requirements:
+
-  	
+For installing Scyther on systems running Microsoft Windows, proceed to
-	windows:	python (enthought)	code.enthought.com/enthon
+'2. Windows'. For installing Scyther on systems running a version of the
-	(all python dependencies, only need graphviz)
+Linux operating system, proceed to '3. Linux'.
-
+
-	python				www.python.org
+
-	wxPython			www.wxpython.org
+2. Microsoft Windows
-	(c)elementtree 	elementtree
+========================================================================
-	effbot.org/zone/element-index.htm (slower but more widely available)
+
-			celementtree 	effbot.org/zone/celementtree.htm (preferred)
+Windows users that already have the Python language installed are
-	graphviz			www.graphviz.org
+advised to follow the generic installation procedure (detailed in
-
+Section 4 below) to install the remaining items. If you don't have (or
-  Optional:
+are not sure) whether you already have python, the following two steps
-
+will get Scyther up and running:
-  	Python Imaging Library		www.pythonware.com/products/pil/
+
-
+2.1. Install GraphViz
-	(It might be possible to include PIL in the sources)
+
-
+  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.2. Install Enthought Python
+
+  Visit:
+  	
+	http://code.enthought.com/enthon/#download
+
+  Download the latest release at the bottom of the page, and install it.
+  Note that this is a fairly large file (+- 125 MB) which can take a
+  while to download.
+
+2.3. Start scyther
+
+  Double-click:
+
+  	scyther-gui.py
+
+  In the directory where you found this file.
+
+
+3. Linux
+========================================================================
+
+For Linux users, it is easiest to follow the generic installation
+procedure (detailed in Section 4 below).
+
+Note for Ubuntu users: all required packages are directly available from
+universe.
+
+
+4. Generic Installation
+========================================================================
+
+4.1. Requirements
+
+To be able to use Scyther, you need the following things:
+
+4.1.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.
+
+4.1.2. Python and Python libraries.
+
+  The graphical user interface of Scyther is written in the Python
+  language. Consequently, the following things are required:
+
+  	Name:			Where to download:
+
+  	Python			http://www.python.org/download/
+	wxPython (*1)		http://www.wxpython.org/download.php
+	cElementtree		http://effbot.org/zone/celementtree.htm
+
+  *1: Note that there are many different wxPython packages. Any package
+  that matches your Python version (currently 2.4) will do just fine.
+
+4.2. Running Scyther
+
+  Start Scyther by executing the file
+
+  	scyther-gui.py
+
+  in the directory where you found this file.
+
+

gui/README.txt

@@ -1,54 +1,54 @@
-------------------------------------------------------------------------
+------------------------------------------------------------------------
-
+
-				Scyther
+				Scyther
-
+
-			       1.0-beta4
+			       1.0-beta4
-
+
-	  a automatic verification tool for security protocols
+	  a automatic verification tool for security protocols
-			     by Cas Cremers
+			     by Cas Cremers
-
+
-			Microsoft Windows binary
+			Microsoft Windows binary
-				  and
+				  and
-	   Linux binary compiled for Linux i686 environments
+	   Linux binary compiled for Linux i686 environments
-
+
-------------------------------------------------------------------------
+------------------------------------------------------------------------
-
+
-
+
-Note: This is a BETA release, and therefore the usual warnings apply.
+Note: This is a BETA release, and therefore the usual warnings apply.
-
+
-
+
-
+
-1. More information
+1. More information
-========================================================================
+========================================================================
-
+
-For more information, see:
+For more information, see:
-
+
-  http://www.win.tue.nl/~ccremers/scyther
+  http://www.win.tue.nl/~ccremers/scyther
-
+
-
+
-2. Starting out
+2. Starting out
-========================================================================
+========================================================================
-
+
-Start the graphical user interface by starting
+Start the graphical user interface by starting
-
+
-  scyther-gui.py
+  scyther-gui.py
-
+
-Some protocol description files (with extension .spdl) can be found in
+Some protocol description files (with extension .spdl) can be found in
-the base directory.  Many other protocol input files can be found in the
+the base directory.  Many other protocol input files can be found in the
-SPORE directory.
+SPORE directory.
-
+
-
+
-3. Citing Scyther
+3. Citing Scyther
-===========================
+===========================
-
+
-For now, there is no official journal paper to cite yet, but you can use
+For now, there is no official journal paper to cite yet, but you can use
-the following information:
+the following information:
-
+
-@misc{wwwscyther,
+@misc{wwwscyther,
-  Author = "C.J.F. Cremers",
+  Author = "C.J.F. Cremers",
-  Title  = "The Scyther Tool : Automated Verification of Security Protocols",
+  Title  = "The Scyther Tool : Automated Verification of Security Protocols",
-  Note   = "\url{http://www.win.tue.nl/~ccremers/scyther}",
+  Note   = "\url{http://www.win.tue.nl/~ccremers/scyther}",
-  url    = "http://www.win.tue.nl/~ccremers/scyther"
+  url    = "http://www.win.tue.nl/~ccremers/scyther"
-}
+}
-
+
-
+