From f4d9ea00427ad0f5d657bab81b6c037163d9f028 Mon Sep 17 00:00:00 2001 From: Cas Cremers Date: Fri, 13 Dec 2013 22:26:16 +0000 Subject: [PATCH 1/7] Experiment with relative links in markdown, enabling better use of README. --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 484889d..369bab3 100644 --- a/README.md +++ b/README.md @@ -55,7 +55,7 @@ Manual We are currently rewriting the manual. The current (incomplete) snapshot of the manual can be found here: - * `./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 ------- From 28c7c12db5d5669c5f69b29e5bc76ade81e2c710 Mon Sep 17 00:00:00 2001 From: Cas Cremers Date: Fri, 13 Dec 2013 22:33:10 +0000 Subject: [PATCH 2/7] 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". + + From d79135fd069578ffdc02459e959e41054f373bc4 Mon Sep 17 00:00:00 2001 From: Cas Cremers Date: Fri, 13 Dec 2013 22:47:47 +0000 Subject: [PATCH 3/7] 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 From 04f4ee6b531dbfffee0253e33b073ba4e066209f Mon Sep 17 00:00:00 2001 From: Cas Cremers Date: Fri, 13 Dec 2013 22:49:41 +0000 Subject: [PATCH 4/7] Further minor fixes. --- gui/INSTALL.md | 40 ++++++++++++++++++++-------------------- 1 file changed, 20 insertions(+), 20 deletions(-) diff --git a/gui/INSTALL.md b/gui/INSTALL.md index 5ef065d..cc54260 100644 --- a/gui/INSTALL.md +++ b/gui/INSTALL.md @@ -27,15 +27,15 @@ from the command line) then you need only the first. 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: + * 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 / - ``` + 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. @@ -51,24 +51,24 @@ from the command line) then you need only the first. 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 + 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 + 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 + http://wiki.wxpython.org/InstallingOnUbuntuOrDebian Running Scyther From 5a7ed5be4cf598e6b28014ac07c506fa35ef1b9c Mon Sep 17 00:00:00 2001 From: Cas Cremers Date: Fri, 13 Dec 2013 22:55:09 +0000 Subject: [PATCH 5/7] Further fixes to markdown of installation file. --- gui/INSTALL.md | 34 +++++++++++++++++----------------- 1 file changed, 17 insertions(+), 17 deletions(-) diff --git a/gui/INSTALL.md b/gui/INSTALL.md index cc54260..4e55db8 100644 --- a/gui/INSTALL.md +++ b/gui/INSTALL.md @@ -8,7 +8,7 @@ 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. +1. ### The GraphViz library ### This library is used by the Scyther tool to draw graphs. It can be freely downloaded from: @@ -18,7 +18,7 @@ from the command line) then you need only the first. Download the latest stable release and install it. -2. Python +2. ### Python ### Stable releases of the Python interpreter are available from: @@ -27,7 +27,7 @@ from the command line) then you need only the first. 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: + * **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 @@ -38,7 +38,7 @@ from the command line) then you need only the first. ``` -3. wxPython libraries. +3. ### wxPython libraries ### The GUI user interface uses the wxPython libraries. @@ -51,24 +51,24 @@ from the command line) then you need only the first. 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 + 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 + 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 + http://wiki.wxpython.org/InstallingOnUbuntuOrDebian Running Scyther @@ -81,7 +81,7 @@ Start Scyther by executing the 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". From 18b35a3bac6d6e647f7437c3803d297450c84a9d Mon Sep 17 00:00:00 2001 From: Cas Cremers Date: Fri, 13 Dec 2013 22:58:26 +0000 Subject: [PATCH 6/7] Added further information. --- gui/INSTALL.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/gui/INSTALL.md b/gui/INSTALL.md index 4e55db8..fd0db99 100644 --- a/gui/INSTALL.md +++ b/gui/INSTALL.md @@ -1,6 +1,12 @@ 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 ------------ @@ -74,6 +80,7 @@ from the command line) then you need only the first. Running Scyther --------------- +Extract the Scyther archive and navigate to the extracted directory. Start Scyther by executing the file From 52ec943b7631c64204c9123c2c5b8ef1fba40e7e Mon Sep 17 00:00:00 2001 From: Cas Cremers Date: Fri, 13 Dec 2013 23:02:27 +0000 Subject: [PATCH 7/7] Updating markdown with relative links. --- gui/README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/gui/README.md b/gui/README.md index 8813c5e..2e62153 100644 --- a/gui/README.md +++ b/gui/README.md @@ -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 -------