org: add an index page
* doc/org/index.org, doc/org/tut.org: New files. * doc/Makefile.am: Add them. * doc/org/setup.org: Adjust HOME link. * doc/org/tools.org: Adjust UP link. * debian/spot-doc.doc-base: The root is now index.html.
This commit is contained in:
parent
e7f5af6c6a
commit
a8f02ed8ca
6 changed files with 70 additions and 2 deletions
2
debian/spot-doc.doc-base
vendored
2
debian/spot-doc.doc-base
vendored
|
|
@ -5,5 +5,5 @@ Abstract: User documentation for Spot
|
||||||
Section: Science/Mathematics
|
Section: Science/Mathematics
|
||||||
|
|
||||||
Format: HTML
|
Format: HTML
|
||||||
Index: /usr/share/doc/spot/userdoc/tools.html
|
Index: /usr/share/doc/spot/userdoc/index.html
|
||||||
Files: /usr/share/doc/spot/userdoc/*.html
|
Files: /usr/share/doc/spot/userdoc/*.html
|
||||||
|
|
|
||||||
|
|
@ -67,6 +67,7 @@ ORG_FILES = \
|
||||||
org/dstar2tgba.org \
|
org/dstar2tgba.org \
|
||||||
org/genltl.org \
|
org/genltl.org \
|
||||||
org/hoa.org \
|
org/hoa.org \
|
||||||
|
org/index.org \
|
||||||
org/ioltl.org \
|
org/ioltl.org \
|
||||||
org/ltl2tgba.org \
|
org/ltl2tgba.org \
|
||||||
org/ltl2tgta.org \
|
org/ltl2tgta.org \
|
||||||
|
|
@ -78,6 +79,7 @@ ORG_FILES = \
|
||||||
org/randaut.org \
|
org/randaut.org \
|
||||||
org/randltl.org \
|
org/randltl.org \
|
||||||
org/tools.org \
|
org/tools.org \
|
||||||
|
org/tut.org \
|
||||||
org/tut01.org \
|
org/tut01.org \
|
||||||
org/tut02.org \
|
org/tut02.org \
|
||||||
org/tut10.org \
|
org/tut10.org \
|
||||||
|
|
|
||||||
47
doc/org/index.org
Normal file
47
doc/org/index.org
Normal file
|
|
@ -0,0 +1,47 @@
|
||||||
|
#+TITLE: Spot
|
||||||
|
#+SETUPFILE: setup.org
|
||||||
|
|
||||||
|
Spot is a C++11 library for ω-automata manipulation and model
|
||||||
|
checking. It has the following notable features:
|
||||||
|
|
||||||
|
- Support for LTL (several syntaxes supported) and the linear fragment of PSL.
|
||||||
|
- Support for ω-automata with arbitrary acceptance condition.
|
||||||
|
- Support for transition-based acceptance (state-based acceptance
|
||||||
|
is supported by a reduction to transition-based acceptance).
|
||||||
|
- The automaton parser can read a stream of automata written in any of
|
||||||
|
three syntaxes ([[http://spinroot.com/spin/Man/never.html][never claims]], [[file:hoa.org][HOA]], or [[http://www.tcs.hut.fi/Software/lbtt/doc/html/Format-for-automata.html][LBTT]]).
|
||||||
|
- Several algorithms for formula manipulation including: simplifying
|
||||||
|
formulas, testing implication or equivalence, testing
|
||||||
|
stutter-invariance, removing some operators by rewriting, ...
|
||||||
|
- Several algorithms for automata manipulation including: product,
|
||||||
|
emptiness checks, simulation-based reductions,
|
||||||
|
minimization of weak-DBA, removal of useless SCCs,
|
||||||
|
acceptance-condition transformations, etc.
|
||||||
|
- In addition to the C++ interface, most of its algorithms
|
||||||
|
are usable via [[file:tools.org][command-line tools]], and via Python bindings.
|
||||||
|
- One of the command-line tool, called [[file:ltlcross.org][=ltlcross=]] is a rewrite
|
||||||
|
of [[http://www.tcs.hut.fi/Software/lbtt/][LBTT]], but with support for PSL and arbitrary acceptance conditions.
|
||||||
|
It could for instance be used to test tools that translate
|
||||||
|
LTL into Rabin automata.
|
||||||
|
|
||||||
|
* Documentation
|
||||||
|
|
||||||
|
- [[file:tools.org][Command-line tools]]
|
||||||
|
- [[file:tut.org][Code examples]]
|
||||||
|
|
||||||
|
* License
|
||||||
|
|
||||||
|
Spot is distributed under a [[http://www.gnu.org/licenses/gpl-3.0.html][GNU GPL v3 license]].
|
||||||
|
|
||||||
|
A consequence is that if you distribute a tool built using Spot, you
|
||||||
|
*must* make the source code of that tool available as well.
|
||||||
|
|
||||||
|
* Staying in touch
|
||||||
|
|
||||||
|
=spot-announce@lrde.epita.fr= is an extremely low-traffic and
|
||||||
|
read-only mailing list for release announcements. If you want to stay
|
||||||
|
informed about future releases of Spot, we invite you to [[https://lists.lrde.epita.fr/listinfo/spot-announce][subscribe]].
|
||||||
|
|
||||||
|
[[mailto:spot@lrde.epita.fr][=spot@lrde.epita.fr=]] is a list for general discussions and questions
|
||||||
|
about Spot. [[https://lists.lrde.epita.fr/listinfo/spot][Subscribe here]] if you want to join, but feel free to send
|
||||||
|
in any question (in English) or bug report without subscribing.
|
||||||
|
|
@ -1,3 +1,3 @@
|
||||||
#+OPTIONS: H:2 num:nil toc:t
|
#+OPTIONS: H:2 num:nil toc:t
|
||||||
#+EMAIL: spot@lrde.epita.fr
|
#+EMAIL: spot@lrde.epita.fr
|
||||||
#+HTML_LINK_HOME: http://spot.lip6.fr/
|
#+HTML_LINK_HOME: index.html
|
||||||
|
|
|
||||||
|
|
@ -1,6 +1,7 @@
|
||||||
# -*- coding: utf-8 -*-
|
# -*- coding: utf-8 -*-
|
||||||
#+TITLE: Command-line tools installed by Spot 1.99
|
#+TITLE: Command-line tools installed by Spot 1.99
|
||||||
#+SETUPFILE: setup.org
|
#+SETUPFILE: setup.org
|
||||||
|
#+HTML_LINK_UP: index.html
|
||||||
|
|
||||||
This document introduces command-line tools that are installed with
|
This document introduces command-line tools that are installed with
|
||||||
the Spot library. We give some examples to highlight possible
|
the Spot library. We give some examples to highlight possible
|
||||||
|
|
|
||||||
18
doc/org/tut.org
Normal file
18
doc/org/tut.org
Normal file
|
|
@ -0,0 +1,18 @@
|
||||||
|
#+TITLE: Code Examples
|
||||||
|
#+SETUPFILE: setup.org
|
||||||
|
#+HTML_LINK_UP: index.html
|
||||||
|
|
||||||
|
|
||||||
|
This section contains code examples for using Spot. This is a work in
|
||||||
|
progress. Feel free to [[mailto:spot@lrde.epita.fr][send]] suggestion of small tasks you would like
|
||||||
|
to see illustrated here.
|
||||||
|
|
||||||
|
|
||||||
|
* Examples with Shell, Python, and C++
|
||||||
|
|
||||||
|
All the following pages show how to perform the same task using the
|
||||||
|
three interfaces supported by Spot: shell commands, Python, or C++.
|
||||||
|
|
||||||
|
- [[file:tut01.org][Parsing and Printing LTL Formulas]]
|
||||||
|
- [[file:tut02.org][Relabeling Formulas]]
|
||||||
|
- [[file:tut10.org][Translating an LTL formula into a never claim]]
|
||||||
Loading…
Add table
Add a link
Reference in a new issue