diff --git a/dist/makedist.sh b/dist/makedist.sh new file mode 100755 index 0000000..a468eb2 --- /dev/null +++ b/dist/makedist.sh @@ -0,0 +1,80 @@ +#!/bin/sh +#------------------------------------------------------------------------------ +# +# makedist.sh +# +# Make a Scyther distribution of the most recent revision. +# +# +# A distribution is a directory +# +# scyther/ +# - readme.txt file with some indications from this +# directory. +# demo/ +# - demo files +# SPORE/ +# - spore files +# scyther/ +# - scyther executable +# + +#------------------------------------------------------------------------------ +# +# Parameters + +ARCHIVE=scyther.tgz + +# Creates a temporary subdirectory here. +TMPDIR=/tmp/scytherdist +WORKNAME=scyther + +# Repository +SVNROOT=https://svn.win.tue.nl/repos/ecss/trunk/protocols/spdl + +#------------------------------------------------------------------------------ +# +# Derived things + +WORKDIR=$TMPDIR/$WORKNAME +CURDIR=$PWD +DEST=$PWD/$ARCHIVE + +#------------------------------------------------------------------------------ +# +# Init + +# Remove old remnants and create a new directory +rm -f $DEST +rm -rf $TMPDIR +mkdir $TMPDIR + +# Create scyther/ +mkdir $WORKDIR + +#------------------------------------------------------------------------------ +# +# Collect required data and set up + + +# Fill +svn export $SVNROOT/SPORE $WORKDIR/SPORE +svn export $SVNROOT/demo $WORKDIR/demo +svn export $SVNROOT/scyther $WORKDIR/scyther + +# Readme +cp readme.txt $WORKDIR + +#------------------------------------------------------------------------------ +# +# Collected all needed data, finish up + +# Compress +cd $TMPDIR +tar zcvf $DEST $WORKNAME + +# Remove garbage +rm -rf $TMPDIR + +#------------------------------------------------------------------------------ +# Done. diff --git a/dist/readme.txt b/dist/readme.txt new file mode 100644 index 0000000..79ac36c --- /dev/null +++ b/dist/readme.txt @@ -0,0 +1,54 @@ +------------------------------------------------------------------------ + + Scyther + + a verification tool for security protocols + by Cas Cremers + +------------------------------------------------------------------------ + + +Note: This is a 1.0beta release, and therefore the usual warnings apply. + + + +1. More information +======================================================================== + +For more information, see: + + http://www.win.tue.nl/~ccremers/scyther + + +2. Starting out +======================================================================== + +To start, run the scyther executable (scyther/scyther) with the --help +switch, or try + + $ scyther/scyther demo/ns3.spdl + +For graphical output, you need: + +- a pdf viewer (xpdf is assumed) +- the GraphViz package (for the 'dot' executable). + +Add the paths 'scyther/' and 'demo/' to your path environment variable +(something like 'export PATH=$PATH:$PWD/demo'), and try + + $ scytherview demo/nsl3.spdl + + +3. Citing Scyther +=========================== + +For now, there is no official journal paper to cite yet, but you can use +the following information: + +@misc{wwwscyther, + Author = "C.J.F. Cremers", + Title = "Scyther security protocol verification tool: documentation", + Note = "\url{http://www.win.tue.nl/~ccremers/scyther}", + url = "http://www.win.tue.nl/~ccremers/scyther" +} +