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:
parent
f1d159845d
commit
2e34fa4248
10 changed files with 138 additions and 23 deletions
|
|
@ -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