Skip to content

Commit 5a98393

Browse files
committed
[Doc] Update README.
1 parent 3cb5771 commit 5a98393

File tree

1 file changed

+8
-9
lines changed

1 file changed

+8
-9
lines changed

README.md

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,15 @@
11
# TSAR Advisor
22

33
This extension proposes some useful information about a program to simplify its parallelization.
4+
It also provide some useful source-to-source transformations for programs as well as automate theire parallelization.
45
The advisor currently support C/C++ languages and based on LLVM & Clang projects.
56

6-
To analyse source code:
7-
* Open C/C++ file
8-
* Use editor context menu to select `TSAR: Analyse file` item
9-
* The description of discovered traits is rendered in the new tab
10-
* Use editor context menu item `TSAR: Close session` to stop analysis
11-
12-
## Features
13-
14-
At this moment only analysis statistic can be presented.
7+
To analyse or transform source code:
158

9+
* Open C/C++ file
10+
* Use context menu or type one of available TSAR commands in the Command Palette.
11+
* If `TSAR: Analyse file` action is used the description of discovered traits is rendered in the new tab.
12+
* If some transformation is requested, the original file is changed on success.
13+
* Some diagnostic messages may be also provided.
1614

15+
> __Attention.__ To run the adviser the TSAR tool must be installed. It must be available in the system PATH or the path to `tsar-server` executable must be configured manually (see `Analysis Server` configuration variable for details). Details about the TSAR tool can be found in [TSAR Wiki](https://github.com/dvm-system/tsar/wiki).

0 commit comments

Comments
 (0)