Skip to content

Commit 1948fa4

Browse files
authored
Developer note (#233)
Developer note
1 parent de99fe8 commit 1948fa4

File tree

1 file changed

+42
-0
lines changed

1 file changed

+42
-0
lines changed

DEVNOTE.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# UTBot Java Developer Guide
2+
3+
Here are the steps for you to jump into UTBot Java.
4+
5+
## Install UTBot Java from source
6+
1. Clone UTBot Java repository via [Git](https://github.com/UnitTestBot/UTBotJava.git)
7+
2. Open project in IDE
8+
9+
![image](https://user-images.githubusercontent.com/106974353/174806216-9d4969b4-51fb-4531-a6d0-94e3734a437a.png)
10+
11+
*don\`t forget to check your Project SDK and Gradle SDK are of 1.8 Java version.
12+
13+
![image](https://user-images.githubusercontent.com/106974353/174812758-fcbabb5b-0411-48d7-aefe-6d69873185e3.png)
14+
![image](https://user-images.githubusercontent.com/106974353/174806632-ed796fb7-57dd-44b5-b499-e9eeb0436f15.png)
15+
16+
3. Open Gradle tool window
17+
4. Launch Task utbot > Tasks > build > assemble
18+
19+
![image](https://user-images.githubusercontent.com/106974353/174807962-18c648fd-b67d-4556-90df-eee690abe6e2.png)
20+
21+
5. Wait for the build to be completed
22+
23+
Done! You\`re awesome and ready for digging the code. 😃
24+
25+
26+
## Development of UTBot Java with IntelliJ IDEA
27+
28+
The majority of the code is written in Kotlin.
29+
30+
The project is divided into Gradle subprojects. The most significant of them are:
31+
1. utbot-framework — all about the engine and tests for it
32+
33+
2. utbot-intellij — IDE plugin
34+
35+
3. utbot-sample — a framework with examples to demonstrate engine capacity
36+
37+
## Testing
38+
39+
The project contains many tests. They are usually placed in test root of the particular Gradle subproject.
40+
41+
While developing, it\`s useful to run tests from utbot-framework subproject. The majority of tests from this subproject generate tests for samples from the utbot-sample subproject.
42+

0 commit comments

Comments
 (0)