Update description

diff --git a/description b/description
index 6438b3a12164cb75df67a150b6a843da94b336c8..fab4ac98a87865c667a51e44f81109f84bdbb37d 100644 (file)
--- a/description
+++ b/description
@@ -1,16 +1,18 @@
-The clang plugin can visualize simple state machines. It is able to\r
-visualize states and transitions. Now it doesn't support orthogonal\r
-states. The state machine can be inside namespaces. In folder examples\r
-you can find some source code of state machines that can be visualized\r
-using this tool.\r
+Boost Statechart Viewer\r
+=======================\r
 \r
-The input file for the program is the file with the state machine,\r
-using the command line you need to specify all source locations for\r
-finding header files, except of system source locations. For doing\r
-this you can use typical compiler options and flags (like -I for\r
-include files). As this is plugin for compiler the program line works\r
-the same as normal compiler. The output format is dot and the output\r
-file can be transformed into the picture using classic dot commands.\r
+This clang plugin can visualize simple state machines implemented with\r
+Boost Statechart library. It is able to visualize states (except for\r
+orthogonal states) and transitions. The examples folder contains some\r
+source code of state machines that can be visualized using this tool.\r
+\r
+The input file for the tool is the source code of the state machine.\r
+On the command line you need to specify all source locations for\r
+finding header files in the same way as you do for normal compilation\r
+(e.g. -I options for include files). As this is plugin for compiler\r
+the program line works the same as normal compiler. The output format\r
+is dot (part of Graphvis project) and the output file can be\r
+transformed into the picture using classic dot commands.\r
 \r
 Example of command line invocation:\r
 \r
@@ -18,5 +20,5 @@ Example of command line invocation:
 \r
 For compiling and running the plugin you need to have LLVM and clang\r
 installed. The program should work with packages distributed with\r
-operating system or you can download LLVM and clang from repositories\r
-and compile it.\r
+common Linux distributions or you can download LLVM and clang from\r
+repositories and compile it.\r