Update README and description.

[boost-statechart-viewer.git] / description

diff --git a/description b/description
index 0b9bf97d66ce5c0a38c9bb8101c41eb7b93e9cb0..b51f5fc0616d134b3eedf7cb9dc6cf03ae0eae82 100644 (file)
--- a/description
+++ b/description
@@ -1,5 +1,8 @@
-The program can visualize simple state machines. It is able to visualize states and transitions. Now it doesn't support orthogonal states. The state machine can be inside namespaces, but not in templates. This program works correctly with basic topic (StopWatch) in your examples. \r
+The clang plugin can visualize simple state machines. It is able to visualize states and transitions. Now it doesn't support orthogonal states. The state machine can be inside namespaces. In folder examples you can find some source code of state machines that can be visualized using this tool. \r
 \r
-The input for the program is the file with the state machine, using the command line you need to specify all source locations for finding header files, except of system source locations. For doing this you can use typical compiler options and flags (like -I for include files). The command line works the same as in the compilers. The output format is dot and the output file can be transformed into the picture using classic dot commands. \r
+The input file for the program is the file with the state machine, using the command line you need to specify all source locations for finding header files, except of system source locations. For doing this you can use typical compiler options and flags (like -I for include files). As this is plugin for compiler the program line works the same as normal compiler. The output format is dot and the output file can be transformed into the picture using classic dot commands. \r
 \r
-For compiling the program you need to have LLVM and Clang installed. The program should work with packages distributed with operating system or you can download LLVM and Clang from repositories and compile it.
\ No newline at end of file
+Example of command line invocation:\r
+clang++ -Xclang -load -Xclang visualizer.so -Xclang -plugin -Xclang visualize-statechart -c file.cpp\r
+\r
+For compiling and running the plugin you need to have LLVM and clang installed. The program should work with packages distributed with operating system or you can download LLVM and clang from repositories and compile it.\r