Skip to content

Commit

Permalink
Working on README.
Browse files Browse the repository at this point in the history
  • Loading branch information
nazavode committed Sep 30, 2015
1 parent 27cc88c commit fe6a5d3
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -45,11 +45,20 @@ An alternative way, more convenient if triggering events progammatically, is to
>>> crossroads.state
"red"

Automaton enforces correctness in two ways:

1. checking that the requested event is *valid*, e.g. a transition from the current state to the destination state
exists in the state machine definition;
#. checking whether the *state graph* representing the automaton is *connected* or not
(e.g.: it must have only one `connected component`_).


Documentation
=============

You can find the full documentation at http://automaton.readthedocs.org.


Contributors
============

Expand All @@ -59,6 +68,9 @@ Thanks to `@simone-campagna <http://github.com/simone-campagna>`_ for the countl
.. _finite-state machine:
https://en.wikipedia.org/wiki/Finite-state_machine

.. _connected component:
https://en.wikipedia.org/wiki/Finite-state_machine

.. |build-status| image:: https://travis-ci.org/fmontag451/automaton.svg?branch=master
:target: https://travis-ci.org/fmontag451/automaton
:alt: Build status
Expand Down

0 comments on commit fe6a5d3

Please sign in to comment.