Skip to content

Commit c5c0a54

Browse files
committed
Update readme.me file
1 parent 0dfe869 commit c5c0a54

File tree

1 file changed

+17
-19
lines changed

1 file changed

+17
-19
lines changed

clion-plugin/README.md

Lines changed: 17 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,54 +1,52 @@
11
# UTBotCpp-CLion-plugin
22
<!-- Plugin description -->
3-
Plugin for communication with UTBotCpp server in CLion.
3+
Plugin to communicate with [UTBotCpp](https://github.com/UnitTestBot/UTBotCpp) server in CLion.
44

55
### Installation
66

7-
1. Clone UTBotCpp and cd there and do:
7+
1. Clone UTBotCpp into selected folder, select it in the command line and run:
88
```
99
cd clion-plugin
1010
./gradlew assembleDist
1111
```
12-
2. Open CLion, go to settings -> plugins
12+
2. Open CLion and go to `settings -> plugins`
1313
3. Click `Install Plugin from Disk...`:
1414
![](images/install/install-from-disk.png)
15-
4. Navigate to plugin folder `clion-plugin`, then go to `build/distributions`
15+
4. Navigate to plugin folder `clion-plugin`, go to `build/distributions`
1616
and choose `zip` file:
1717
![](images/install/choose-zip.png)
1818
5. Restart CLion
1919

20-
2120
### Configuration
2221

2322
#### Using quickstart wizard
24-
When you open a plugin for the first time the quickstart wizard will appear.
23+
When the plugin is opened for the first time, a quickstart wizard appears.
2524

2625
![](images/plugin_usage/wizard.png)
2726

28-
You can open it manually at any time by clicking on connection status and choosing
29-
`Show Quickstart Wizard`.
27+
You can open it manually any time: click on `connection status` and choose
28+
`Show Quickstart Wizard` action.
3029

3130
![](images/plugin_usage/show_wizard.png)
3231

33-
Or you can do it by pressing `shift` twice and finding an action:
32+
or press `shift` twice and find this action:
3433

3534

3635
![](images/plugin_usage/find-wizard-action.png)
3736

3837
#### Using settings
3938

40-
You also can configure plugin manually in settings, where you will find
41-
all configuration options.
39+
You can also configure plugin using settings. All options can be set manually.
4240

43-
1. Open plugin settings in settings - Tools - UTBot Settings
44-
2. Click `detect paths`. It will try to get source paths, build dir paths from CLion
45-
CMake model.
46-
3. Specify absolute path to build directory, it should be different from build directory that CLion uses,
47-
because there can be conflicts between UTBotCpp and CLion. For example, if CLion uses `project_path/cmake-build-debug`,
48-
then you can specify `project_path/utbot_build`.
41+
1. Open plugin settings in `settings` - `Tools` - `UTBot Settings`
42+
2. Click `detect paths`. It tries to get source paths and build directories paths from CLion
43+
cmake model.
44+
3. Specify an absolute path to the build directory, it should be different from the build directory that CLion uses,
45+
because conflicts between UTBotCpp and CLion may occur. For example, if CLion uses `project_path/cmake-build-debug`,
46+
you can specify `project_path/utbot_build`.
4947
4. For target path specify `/utbot/auto/target/path`
50-
5. Specify path to test folder.
51-
6. Specify name of the server and port.
48+
5. Specify a path to test folder.
49+
6. Specify a name of the server and port.
5250
7. If you use docker to run UTBotCpp and your project is mounted to docker,
5351
you can specify path to project inside docker.
5452

0 commit comments

Comments
 (0)