Remove clang and llvm submodules

[boost-statechart-viewer.git] / www / index.mdwn

diff --git a/www/index.mdwn b/www/index.mdwn
index cc433929955c49baa2f1add389b4c2e6069b06d5..6c4bf13931b98ddaa486f6c6ea891bee3ca5d276 100644 (file)
--- a/www/index.mdwn
+++ b/www/index.mdwn
@@ -3,35 +3,42 @@
 Overview
 ---------
 
-Boost-statechart-viewer is a program for visualization state state
+Boost-statechart-viewer is a program for visualization of state
 machines written in C++ with [boost][boost]/[statechart][statechart]
 library. The program itself is written in C++ and uses [clang][clang]
-from [LLVM][llvm] project for analyzing the source code.
+from [LLVM][llvm] project for analyzing the source code. This program
+is released under the GNU GPL license.
 
 [boost]: http://www.boost.org/
 [statechart]: http://www.boost.org/doc/libs/1_46_1/libs/statechart/doc/index.html
 [clang]: http://clang.llvm.org/
 [llvm]: http://llvm.org/
 
+NEWS
+-----
+- 2012-07-11 We have got a new [mailing list][list].
+- 2011-08-11 Added support for orthogonal states.
+
 Authors
 --------
 
-Petr Silhavik <silhape2@fel.cvut.cz> <br>
-Michal Sojka  <sojkam1@fel.cvut.cz>
-
-For compiling
-and correctly working program is necessary to have LLVM and clang
-version 2.9.
+[list]: https://rtime.felk.cvut.cz/mailman/listinfo/boost-statechart-viewer
 
+Petr Silhavik, Michal Sojka. You can contact us using a
+[mailing list][list] at <boost-statechart-viewer@rtime.felk.cvut.cz>.
 
 Status
 -------
 
-- The program can found states and transitions in the source code.
+- The program can found states and transitions in the source code. Now it also supports orthogonal states.
 - The program understands all options and flags as the compilers (gcc, clang, ...).
 - State machines can be defined in more than one file.
-- Now it doesn't support orthogonal states.
-- The state machine can be inside many namespaces, but not inside templates. 
+- The state machine can be inside many namespaces, but not inside templates.
+
+For compiling and correctly working program it is necessary to have
+LLVM and clang version 2.9. We are currently trying to update it for
+LLVM 3.1.
+
 
 Usage
 ------
@@ -48,10 +55,12 @@ the program stops.
     ./visualizer main.cpp -o graph.dot -I /home/petr/install/
 
 The output file can be transformed into the picture using classical
-dot commands (e.g. `dot -Tpng graph.dot -o graph.png`) . The initial
+[dot][graphviz] commands (e.g. `dot -Tpng graph.dot -o graph.png`) . The initial
 state is double outlined. Each transition has a label with the name of
 the triggering event.
 
+[graphviz]: http://www.graphviz.org/
+
 Download:
 ---------