org: add installation instructions
* doc/org/install.org: New file. * doc/Makefile.am: Add it. * doc/org/index.org: Link to it. * doc/org/setup.org: Add macro for various version numbers. * doc/org/tools.org: Update version number. * NEWS, README, bench/ltl2tgba/README, debian/control, debian/copyright: Update URLs to website.
This commit is contained in:
Alexandre Duret-Lutz
parent
f1d159845d
commit
2e34fa4248
10 changed files with 138 additions and 23 deletions
12
NEWS
12
NEWS
|
|
@ -514,7 +514,7 @@ New in spot 1.2.3 (2014-02-11)
|
|||
- The SPOT_SATLOG environment variable can be set to a filename to
|
||||
obtain statistics about the different iterations of the
|
||||
SAT-based minimization. For an example, see
|
||||
http://spot.lip6.fr/userdoc/satmin.html
|
||||
http://spot.lrde.epita.fr/satmin.html
|
||||
- The bench/dtgbasat/ benchmark has been updated to use SPOT_SATLOG
|
||||
and record more statistics.
|
||||
- The default value for the SPOT_SATSOLVER environment
|
||||
|
|
@ -605,7 +605,7 @@ New in spot 1.2.1 (2013-12-11)
|
|||
to help escape formulas in CSV files.
|
||||
|
||||
- Please check
|
||||
http://spot.lip6.fr/userdoc/csv.html
|
||||
http://spot.lrde.epita.fr/csv.html
|
||||
for some discussion and examples of the last few features.
|
||||
|
||||
* Bug fixes:
|
||||
|
|
@ -667,7 +667,7 @@ New in spot 1.2 (2013-10-01)
|
|||
non-deterministic Büchi automata with Generalized acceptance.
|
||||
These are then degeneralized if requested.
|
||||
|
||||
See http://spot.lip6.fr/userdoc/dstar2tgba.html for some
|
||||
See http://spot.lrde.epita.fr/dstar2tgba.html for some
|
||||
examples, and the man page for more reference.
|
||||
|
||||
- The %S escape sequence used by ltl2tgba --stats to display the
|
||||
|
|
@ -690,7 +690,7 @@ New in spot 1.2 (2013-10-01)
|
|||
deterministic automaton more efficiently) and is disabled by
|
||||
default. See the spot-x(7) man page for documentation about the
|
||||
related options: sat-minimize, sat-states, sat-acc, state-based.
|
||||
See also http://spot.lip6.fr/userdoc/satmin.html for some
|
||||
See also http://spot.lrde.epita.fr/satmin.html for some
|
||||
examples.
|
||||
|
||||
- ltlfilt, genltl, and randltl now have a --latex option to output
|
||||
|
|
@ -1032,7 +1032,7 @@ New in spot 1.1 (2013-04-28):
|
|||
* Documentation:
|
||||
|
||||
- org-mode files used to generate the documentation about
|
||||
command-line tools (shown at http://spot.lip6.fr/userdoc/tools.html)
|
||||
command-line tools (shown at http://spot.lrde.epita.fr/tools.html)
|
||||
is distributed in doc/org/. The resulting html files are also
|
||||
in doc/userdoc/.
|
||||
|
||||
|
|
@ -1183,7 +1183,7 @@ New in spot 1.0 (2012-10-27):
|
|||
output more statistics.
|
||||
|
||||
An introduction to these tools can be found on-line at
|
||||
http://spot.lip6.fr/userdoc/tools.html
|
||||
http://spot.lrde.lip6.fr/tools.html
|
||||
|
||||
The former test versions of genltl and randltl have been removed
|
||||
from the source tree. The old version of ltl2tgba with its
|
||||
|
|
|
|||
18
README
18
README
|
|
@ -46,7 +46,7 @@ test bench), mostly fixing errors reported by recent compilers.
|
|||
However Spot now distributes its own reimplementation of LBTT, called
|
||||
ltlcross, so the use of LBTT is completely optional. The last
|
||||
modified version of LBTT we used to distribute can now be found at
|
||||
http://spot.lip6.fr/dl/lbtt-1.2.1a.tar.gz
|
||||
http://www.lrde.epita.fr/dload/spot/lbtt-1.2.1a.tar.gz
|
||||
If some lbtt binary is found on your system, it will be used in the
|
||||
test suite in addition to ltlcross.
|
||||
|
||||
|
|
@ -62,12 +62,12 @@ In addition to its usual options, ./configure will accept some
|
|||
flags specific to Spot:
|
||||
|
||||
--disable-python
|
||||
Turn off the compilation of Python bindings. These bindings offers a
|
||||
convenient interface with used in an IPython notebook, and are
|
||||
also used to build the CGI script that translates LTL formulae
|
||||
on-line. You may safely disable these, especially if you do not
|
||||
have a working Python 3.2+ installation or if you are attempting
|
||||
some cross-compilation.
|
||||
Turn off the compilation of Python bindings. These bindings
|
||||
offers a convenient interface when used in an IPython notebook,
|
||||
and are also used to build the CGI script that translates LTL
|
||||
formulas on-line. You may safely disable these, especially if you
|
||||
do not have a working Python 3.2+ installation or if you are
|
||||
attempting some cross-compilation.
|
||||
|
||||
--enable-devel
|
||||
Enable debugging symbols, turn off aggressive optimizations, and
|
||||
|
|
@ -123,8 +123,8 @@ Some documentation can be found in the doc/ directory.
|
|||
|
||||
"make install" will install man pages for command-line tools. (These
|
||||
man pages can also be found in the src/bin/man/ subdirectory of the
|
||||
source tree.) Additional documentation about these tools can be
|
||||
found on-line at http://spot.lip6.fr/userdoc/tools.html
|
||||
source tree.) Additional documentation about these tools can be found
|
||||
in doc/userdoc/, or on-line at http://spot.lrde.lip6.fr/tools.html
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -130,7 +130,7 @@ For all these values (except count), smaller numbers are better.
|
|||
|
||||
|
||||
More details about ltlcross (used to produce these outputs) can be
|
||||
found in its man page, and at http://spot.lip6.fr/userdoc/tools.html
|
||||
found in its man page, and at http://spot.lrde.epita.fr/tools.html
|
||||
|
||||
|
||||
==============================================
|
||||
|
|
@ -145,7 +145,3 @@ For instance try
|
|||
TOOLS=./tools.sim make -j3 run
|
||||
|
||||
to benchmark several simulation-related options.
|
||||
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
2
debian/control
vendored
2
debian/control
vendored
|
|
@ -4,7 +4,7 @@ Priority: optional
|
|||
Maintainer: Alexandre Duret-Lutz <adl@lrde.epita.fr>
|
||||
Build-Depends: debhelper (>= 9), python3-all-dev
|
||||
Standards-Version: 3.9.6
|
||||
Homepage: http://spot.lip6.fr/
|
||||
Homepage: http://spot.lrde.lip6.fr/
|
||||
|
||||
Package: spot
|
||||
Architecture: any
|
||||
|
|
|
|||
2
debian/copyright
vendored
2
debian/copyright
vendored
|
|
@ -1,6 +1,6 @@
|
|||
Format: http://www.debian.org/doc/packaging-manuals/copyright-format/1.0/
|
||||
Upstream-Name: spot
|
||||
Source: http://spot.lip6.fr/dl/
|
||||
Source: http://spot.lrde.epita.fr/dload/spot/
|
||||
|
||||
Files: *
|
||||
Copyright: 2003-2007 Laboratoire d'Informatique de Paris 6 (LIP6)
|
||||
|
|
|
|||
|
|
@ -68,6 +68,7 @@ ORG_FILES = \
|
|||
org/genltl.org \
|
||||
org/hoa.org \
|
||||
org/index.org \
|
||||
org/install.org \
|
||||
org/ioltl.org \
|
||||
org/ltl2tgba.org \
|
||||
org/ltl2tgta.org \
|
||||
|
|
|
|||
|
|
@ -24,6 +24,11 @@ checking. It has the following notable features:
|
|||
It could for instance be used to test tools that translate
|
||||
LTL into Rabin automata.
|
||||
|
||||
* Latest version
|
||||
|
||||
The latest version is *{{{LASTRELEASE}}}* and was released on
|
||||
*{{{LASTDATE}}}*. You can [[file:install.org][download it here]].
|
||||
|
||||
* Documentation
|
||||
|
||||
- [[file:tools.org][Command-line tools]]
|
||||
|
|
|
|||
108
doc/org/install.org
Normal file
108
doc/org/install.org
Normal file
|
|
@ -0,0 +1,108 @@
|
|||
# -*- coding: utf-8 -*-
|
||||
#+TITLE: Installing Spot
|
||||
#+SETUPFILE: setup.org
|
||||
#+HTML_LINK_UP: index.html
|
||||
|
||||
* Installing from a tarball
|
||||
|
||||
The latest release of Spot is version {{{LASTRELEASE}}}:
|
||||
|
||||
- {{{LASTTARBALL}}} (see also the {{{LASTNEWS}}})
|
||||
|
||||
Past releases can be found [[https://www.lrde.epita.fr/dload/spot/][in the same directory]]. If you are
|
||||
interested in /future/ releases, you can always peek at the [[http://teamcity.lrde.epita.fr/viewLog.html?buildTypeId%3Dbt16&buildId%3DlastFinished&buildBranch%3Dnext&tab%3Dartifacts&guest%3D1][last
|
||||
successful development build]].
|
||||
|
||||
** Requirements
|
||||
|
||||
Spot requires a C++11-compliant compiler. =g++= 4.8 or later, as well
|
||||
as =clang++= 3.5 or later should work.
|
||||
|
||||
Spot expects a complete installation of Python (version 3.2 or later).
|
||||
Especially, Python's headers files should be installed. If you don't
|
||||
have Python installed, and do NOT want to install it, you should run
|
||||
=./configure= with the =--disable-python= option.
|
||||
|
||||
** Installation
|
||||
|
||||
The installation follows the usual =./configure=, =make=, =make install= steps.
|
||||
|
||||
Please *do* install Spot somewhere: while skipping =make install= and
|
||||
running the command-line tools directly from the
|
||||
=spot-{{{LASTRELEASE}}}/src/bin/= directory should work, it will be
|
||||
slower than if you run =make install= and run the installed binaries.
|
||||
|
||||
By default, =make install= will install everything under
|
||||
=/usr/local/=, so unless you have write access to this directory you
|
||||
will either have to run =sudo make install=, or choose another
|
||||
installation prefix.
|
||||
|
||||
For instance to install Spot in =~/usr= (i.e., in your home
|
||||
directory), use
|
||||
|
||||
#+BEGIN_SRC sh
|
||||
./configure --prefix ~/usr
|
||||
make
|
||||
make install
|
||||
#+END_SRC
|
||||
|
||||
Files =INSTALL= and =README= included in the tarball contains more
|
||||
explanations about the various options you can use during this
|
||||
process.
|
||||
|
||||
* Installing the Debian packages
|
||||
|
||||
We build Debian packages for amd64 and i386, for both releases and the
|
||||
development versions. Packages for releases are built for Debian
|
||||
Jessie (a.k.a. Debian stable) while packages for development are built
|
||||
for Sid (a.k.a. Debian unstable).
|
||||
|
||||
Here is how to install the stable packages:
|
||||
|
||||
#+BEGIN_SRC sh
|
||||
echo 'deb http://www.lrde.epita.fr/repo/debian/ stable/' >> /etc/apt/sources.list
|
||||
apt-get update
|
||||
apt-get install spot libspot-dev spot-doc python3-spot # Or a subset of those
|
||||
#+END_SRC
|
||||
|
||||
Here is how to install the unstable packages:
|
||||
|
||||
#+BEGIN_SRC sh
|
||||
echo 'deb http://www.lrde.epita.fr/repo/debian/ unstable/' >> /etc/apt/sources.list
|
||||
apt-get update
|
||||
apt-get install spot libspot-dev spot-doc python3-spot # Or a subset of those
|
||||
#+END_SRC
|
||||
|
||||
The package =spot= contains the libraries and [[file:tools.org][command-line
|
||||
tools]]. =libspot-dev= contains the header files if you plan to use Spot
|
||||
in a C++11 program. =spot-doc= contains some html (including these
|
||||
pages) and pdf documentation. Finally =python3-spot= contains some
|
||||
Python bindings (this package also installs some ipython notebooks
|
||||
that you can use as examples).
|
||||
|
||||
These packages should work in a recent *Ubuntu* as well, provided you
|
||||
also add a path to a repository that distributes the GCC 4.9 runtime.
|
||||
You can do that for instance with:
|
||||
|
||||
#+BEGIN_SRC sh
|
||||
add-apt-repository -y ppa:ubuntu-toolchain-r/test
|
||||
#+END_SRC
|
||||
|
||||
|
||||
* Installing from git
|
||||
|
||||
The =master= branch of the git repository contains the code for the
|
||||
latest released version, possibly with a few yet-to-be-released
|
||||
bugfixes. The =next= branch is the main development branch, and contains
|
||||
the (working) code that should be part of the next major release.
|
||||
|
||||
To clone the git repository, use
|
||||
|
||||
#+BEGIN_SRC sh
|
||||
git clone https://gitlab.lrde.epita.fr/spot/spot.git
|
||||
#+END_SRC
|
||||
|
||||
This should put you on the =next= branch by default. From there, read
|
||||
the [[https://gitlab.lrde.epita.fr/spot/spot/blob/next/HACKING][HACKING]] file that should be at the top of your cloned repository:
|
||||
it lists all the tools you should install before attempting to compile
|
||||
the source tree.
|
||||
|
|
@ -1,3 +1,8 @@
|
|||
#+OPTIONS: H:2 num:nil toc:t
|
||||
#+EMAIL: spot@lrde.epita.fr
|
||||
#+HTML_LINK_HOME: index.html
|
||||
#+MACRO: SPOTVERSION 1.99b
|
||||
#+MACRO: LASTRELEASE 1.2.6
|
||||
#+MACRO: LASTTARBALL [[file:http:/www.lrde.epita.fr/dload/spot/spot-1.2.6.tar.gz][=spot-1.2.6.tar.gz=]]
|
||||
#+MACRO: LASTNEWS [[https://gitlab.lrde.epita.fr/spot/spot/blob/spot-1-2-6/NEWS][summary of the changes]]
|
||||
#+MACRO: LASTDATE 2014-12-06
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
# -*- coding: utf-8 -*-
|
||||
#+TITLE: Command-line tools installed by Spot 1.99
|
||||
#+TITLE: Command-line tools installed by Spot {{{SPOTVERSION}}}
|
||||
#+SETUPFILE: setup.org
|
||||
#+HTML_LINK_UP: index.html
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue