Skip to content

Commit 37f8a86

Browse files
committed
Update usage.md file
1 parent 278b457 commit 37f8a86

File tree

1 file changed

+14
-14
lines changed

1 file changed

+14
-14
lines changed

clion-plugin/USAGE.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -2,28 +2,27 @@
22
# How to use plugin
33

44
### Check connection status
5-
To use plugin you should be connected to server, you can check
6-
the connection status in status bar:
5+
You must be connected to server to use plugin. \
6+
Connection status can be checked in the status bar.
77

88
![](images/plugin_usage/connectionStatus.png)
99

1010
### Configure project and generate json files
11-
For test generation to work your project must be configured by server.
1211

12+
Your project must be configured by server to generate tests.
1313

14-
To send request for project configuration or generation of json files
15-
click on connection status in the status bar and choose suitable option:
16-
14+
To send request for project configuration or json files generation,
15+
click on `connection status` in the status bar and choose a suitable option:
1716

1817
![](images/plugin_usage/generateJson.png)
1918

2019
Plugin sends request for project configuration when you open
21-
the project. Sometimes configuration fails, and then after you changed
20+
the project. Sometimes configuration fails, then after changing
2221
your project you need to send the request for project configuration.
2322

2423
### Choose source folders
2524

26-
The server needs to know under what folders source files are.
25+
The server needs to know the folders source files are located in.
2726
The source folders are marked with green icons in the project view:
2827

2928
![](images/plugin_usage/source-folders.png)
@@ -33,22 +32,23 @@ You can mark/unmark selected folders from context menu.
3332
![](images/plugin_usage/mark-unmark-folders.gif)
3433

3534
### How to request tests generation
36-
Open a c/cpp file, right click in the text editor and in context menu
37-
choose suitable option:
35+
36+
Open a c/cpp file, right click in the text editor and
37+
choose suitable option in the context menu:
3838

3939
![editor actions](images/plugin_usage/editorActions.png)
4040

41-
To generate tests for a folder right click on a folder in project view
41+
For example, to generate tests for the folder, right click on it in the project view
4242
and choose `Generate for folder`:
4343

4444
![project view actions](images/plugin_usage/projectViewActions.png)
4545

4646
### See logs from server and client
47-
You can see what messages are sent to the server and server logging messages.
48-
For that click on the `UTBot consoles` tab in the bottom right corner:
47+
48+
You can see messages that are sent to the server and server own logging messages. Just click on the `UTBot consoles` tab in the bottom right corner:
4949

5050
![UTBot consoles tab](images/plugin_usage/consolesTab.png)
5151

52-
add choose the needed tab:
52+
add choose the required tab:
5353

5454
![UTBot consoles view](images/plugin_usage/consolesToolWindow.png)

0 commit comments

Comments
 (0)