|
1 | 1 | # UTBotCpp-CLion-plugin
|
2 | 2 | <!-- 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. |
4 | 4 |
|
5 | 5 | ### Installation
|
6 | 6 |
|
7 |
| -1. Clone UTBotCpp and cd there and do: |
| 7 | +1. Clone UTBotCpp into selected folder, select it in the command line and run: |
8 | 8 | ```
|
9 | 9 | cd clion-plugin
|
10 | 10 | ./gradlew assembleDist
|
11 | 11 | ```
|
12 |
| -2. Open CLion, go to settings -> plugins |
| 12 | +2. Open CLion and go to `settings -> plugins` |
13 | 13 | 3. Click `Install Plugin from Disk...`:
|
14 | 14 | 
|
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` |
16 | 16 | and choose `zip` file:
|
17 | 17 | 
|
18 | 18 | 5. Restart CLion
|
19 | 19 |
|
20 |
| - |
21 | 20 | ### Configuration
|
22 | 21 |
|
23 | 22 | #### 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. |
25 | 24 |
|
26 | 25 | 
|
27 | 26 |
|
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. |
30 | 29 |
|
31 | 30 | 
|
32 | 31 |
|
33 |
| -Or you can do it by pressing `shift` twice and finding an action: |
| 32 | +or press `shift` twice and find this action: |
34 | 33 |
|
35 | 34 |
|
36 | 35 | 
|
37 | 36 |
|
38 | 37 | #### Using settings
|
39 | 38 |
|
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. |
42 | 40 |
|
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`. |
49 | 47 | 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. |
52 | 50 | 7. If you use docker to run UTBotCpp and your project is mounted to docker,
|
53 | 51 | you can specify path to project inside docker.
|
54 | 52 |
|
|
0 commit comments