Skip to content

Commit b2dbdba

Browse files
committed
Update readme
1 parent 691af75 commit b2dbdba

File tree

1 file changed

+22
-11
lines changed

1 file changed

+22
-11
lines changed

DEVNOTE.md

Lines changed: 22 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -43,18 +43,17 @@ To build UTBot from sources:
4343
> You can type `localhost` as `host` if you are inside terminal of a host machine)
4444
> If you are prompted a password, enter `utbot`.
4545
46-
5. Clone UTBotCpp repository into home directory **inside docker container**, preferably with ssh.
47-
48-
And don't forget to clone modules with `git submodule update --init --recursive`
49-
6. `cd` into `UTBotCpp` directory and run `build.sh` — it is the script that builds KLEE UTBot and runs UTBot unit tests
50-
7. Navigate to `UTBotCpp/server/build` directory and launch the binary with `./utbot server` command. Now the server is running.
51-
8. Launch VS Code on your local machine. Use VS Code [Remote-SSH](https://code.visualstudio.com/docs/remote/ssh) to get access to the docker insides. Navigate to `UTBotCpp/vscode-plugin` directory and run `build.sh` script.
52-
9. Press F5 (*Run Extension*). This will run UTBot VS Code plugin.
53-
10. A new VS Code window will open; this window will have UTBot VS Code plugin enabled. In this new folder, open `UTBotCpp/integration-tests/c-example` directory.
54-
11. When UTBot Quickstart Wizard requests you to enter server host and port, specify `localhost` and UTBot server run port 2121, respectively.
46+
6. Clone UTBotCpp repository into home directory **inside docker container**, preferably with ssh.
47+
7. `cd` into `UTBotCpp` directory and run `build.sh` — it is the script that builds KLEE UTBot and runs UTBot unit tests
48+
8. Clone submodules `git submodule update --init --recursive`
49+
9. Navigate to `UTBotCpp/server/build` directory and launch the binary with `./utbot server` command. Now the server is running.
50+
10. Launch VS Code on your local machine. Use VS Code [Remote-SSH](https://code.visualstudio.com/docs/remote/ssh) to get access to the docker insides. Navigate to `UTBotCpp/vscode-plugin` directory and run `build.sh` script.
51+
11. Press F5 (*Run Extension*). This will run UTBot VS Code plugin.
52+
12. A new VS Code window will open; this window will have UTBot VS Code plugin enabled. In this new folder, open `UTBotCpp/integration-tests/c-example` directory.
53+
13. When UTBot Quickstart Wizard requests you to enter server host and port, specify `localhost` and UTBot server run port 2121, respectively.
5554
![Oops, something went wrong! Please look at wizardInstall.gif](media/wizardInstall.gif "UTBot Wizard Demo")
56-
12. Select project path as `/home/utbot/UTBotCpp/integration-tests/c-example`;
57-
13. You are now ready to experience UTBot capabilities! You can view possible commands in Command Palette (Press F1 and type in UTBot).
55+
14. Select project path as `/home/utbot/UTBotCpp/integration-tests/c-example`;
56+
15. You are now ready to experience UTBot capabilities! You can view possible commands in Command Palette (Press F1 and type in UTBot).
5857

5958
If you want to change UTBot test generation preferences, you can edit them in File > Preferences > Settings > Extensions > UnitTestBot.
6059
After UTBot configuration, you can select your source directories with the tab on the VSCode toolbar on the left. Then, you can generate tests with the use of Command Palette. Press **F1** and type in "UTBot": You will see tests generation options.
@@ -105,6 +104,18 @@ Remove the following line in utbot_docker_dev.sh:
105104
-v $MOUNT_LOCAL_NAME:/home/utbot/mnt \
106105
```
107106
107+
### Failed to load project in CLion
108+
If error like this happens then you try load Cmake in CLion
109+
```
110+
CMake File API: C:\Users\kWX1061625\work\UTBotCpp\server\cmake-build-debug-remote-host-ml: target-gmock-Debug-0b6fa789e179f468efb4.json: no CMakeLists.txt file at '\utbot_distr\gtest\googlemock\CMakeLists.txt'
111+
```
112+
Settings | Advanced Settings -> "Use legacy generator for CMake 3.20 and higher".
113+
114+
Settings | Build, Execution, Deployment | CMake -> Generator: "Use default"
115+
116+
[issue](https://youtrack.jetbrains.com/issue/CPP-27998)
117+
118+
108119
### Problems with build in Visual Studio Code
109120
If you experience this error:
110121
```shell

0 commit comments

Comments
 (0)