Skip to content

Commit b0652f8

Browse files
authored
SysReq (for users and devs separately) and minor updates to README added (#741)
* SysReq and minor updates to README added * SysReq: for users and devs separately
1 parent 532317c commit b0652f8

File tree

2 files changed

+53
-20
lines changed

2 files changed

+53
-20
lines changed

README.md

Lines changed: 25 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,37 @@
1-
[![UTBot Java: build and run tests](https://github.com/UnitTestBot/UTBotJava/actions/workflows/build-and-run-tests.yml/badge.svg)](https://github.com/UnitTestBot/UTBotJava/actions/workflows/build-and-run-tests.yml)
1+
[![UnitTestBot: build and run tests](https://github.com/UnitTestBot/UTBotJava/actions/workflows/build-and-run-tests.yml/badge.svg)](https://github.com/UnitTestBot/UTBotJava/actions/workflows/build-and-run-tests.yml)
22
[![Plugin and CLI: publish as archives](https://github.com/UnitTestBot/UTBotJava/actions/workflows/publish-plugin-and-cli.yml/badge.svg)](https://github.com/UnitTestBot/UTBotJava/actions/workflows/publish-plugin-and-cli.yml)
33

4-
👉 Find UTBot Java on [JetBrains Marketplace](https://plugins.jetbrains.com/plugin/19445-unittestbot).
4+
👉 Find UnitTestBot on [JetBrains Marketplace](https://plugins.jetbrains.com/plugin/19445-unittestbot).
55

6-
👉 Visit the [official UTBot website](https://www.utbot.org/).
6+
👉 Visit the [official UnitTestBot website](https://www.utbot.org/).
77

8-
# What is UTBot Java?
9-
UTBot Java is the tool for **automated unit test generation**. It produces ready-to-use test cases for Java — with valid inputs and comments. It can even predict whether the tests fail or pass. You can analyze them, run them, show coverage — as if you've created them personally.
8+
# What is UnitTestBot?
9+
UnitTestBot is the tool for **automated unit test generation** and **precise code analysis**. It produces ready-to-use
10+
test
11+
cases for
12+
Java — with
13+
valid inputs and comments. It can even predict whether the tests fail or pass. You can analyze them, run them, show coverage — as if you've created them personally.
1014

11-
The **symbolic execution engine** paired with a **smart fuzzing technique** constitutes the core of UTBot Java. It helps to **find errors** and **prevent regressions** in the code in a much more efficient way — UTBot Java **maximizes path coverage** while **minimizing the number of tests and false positives**.
15+
The **symbolic execution engine** paired with a **smart fuzzing technique** constitutes the core of UnitTestBot. It helps to **find errors** and **prevent regressions** in the code in a much more efficient way — UnitTestBot **maximizes path coverage** while **minimizing the number of tests and false positives**.
1216

13-
UTBot Java represents all the test summaries in a **human-readable format**. The intelligible test method names and comments help you to control the whole testing process. Test failed? The summary refers you to the related branch or the condition under test.
17+
UnitTestBot represents all the test summaries in a **human-readable format**. The intelligible test method names and comments help you to control the whole testing process. Test failed? The summary refers you to the related branch or the condition under test.
1418

1519
# Get started
1620
Try the **[online demo](https://www.utbot.org/utbot/)** to generate unit tests with one click.
1721

18-
Get to know the **full version** of UTBot Java plugin with this quick guide:
22+
Get to know the **full version** of UnitTestBot plugin with this quick guide:
1923

2024
<details>
21-
<summary>Install UTBot Java plugin for IntelliJ IDEA</summary>
25+
<summary>Install UnitTestBot plugin for IntelliJ IDEA</summary>
2226

23-
Try the most straightforward path to start using UTBot plugin.
24-
1. Open your IntelliJ IDEA. If you don't have one, get it from [JetBrains](https://www.jetbrains.com/idea/download/#section=windows).
25-
2. Go to **File → Settings... → Plugins → Marketplace**.
26-
3. In the search field type *UTBot* — you'll see the UnitTestBot plugin page.
27-
4. Press the **Install** button and wait until it changes to **Installed**, then click **OK**.
27+
Try the most straightforward path to start using UnitTestBot plugin.
28+
1. Please check the [system requirements](SystemRequirements.md).
29+
2. Open your IntelliJ IDEA.
30+
3. Go to **File → Settings... → Plugins → Marketplace**.
31+
4. In the search field type *UnitTestBot* — you'll see the UnitTestBot plugin page.
32+
5. Press the **Install** button and wait until it changes to **Installed**, then click **OK**.
2833

29-
Now you can find the UTBot plugin enabled in the **File → Settings → Plugins** window.
34+
Now you can find the UnitTestBot plugin enabled in the **File → Settings → Plugins** window.
3035

3136
____________
3237
</details>
@@ -73,8 +78,8 @@ Right-click the test class, choose **More Run/Debug → Run ... with Coverage**.
7378
____________
7479
</details>
7580

76-
# Contribute to UTBot Java
77-
UTBot Java is an open source project. We welcome everyone who wants to make UTBot Java better — introduce a new feature or report a bug. We have only one kind request for our contributors: we expect you to prove the necessity and quality of the suggested changes.
81+
# Contribute to UnitTestBot
82+
UnitTestBot is an open source project. We welcome everyone who wants to make UnitTestBot better — introduce a new feature or report a bug. We have only one kind request for our contributors: we expect you to prove the necessity and quality of the suggested changes.
7883

7984
How can you do this? Refer to our [Contributing guide](https://github.com/UnitTestBot/UTBotJava/blob/main/CONTRIBUTING.md).
8085

@@ -83,9 +88,9 @@ Feel free to join the [Discussions](https://github.com/UnitTestBot/UTBotJava/dis
8388
And thank you for your time and effort! ⭐
8489

8590
# Find support
86-
Having troubles with using UTBot Java? Contact us [directly](https://www.utbot.org/contact).
91+
Having troubles with using UnitTestBot? Contact us [directly](https://www.utbot.org/contact).
8792

88-
# Find more UTBot products
89-
[UTBot Cpp](https://github.com/UnitTestBot/UTBotCpp) — try it yourself and tell your friends: it is the tool for automated unit test generation developed especially for C/C++.
93+
# Find more UnitTestBot products
94+
You can also try [UnitTestBot](https://github.com/UnitTestBot/UTBotCpp) developed especially for C/C++.
9095

9196
You are welcome to [contribute](https://github.com/UnitTestBot/UTBotCpp/blob/main/CONTRIBUTING.md) to it too!

SystemRequirements.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# System requirements
2+
3+
---
4+
5+
### To generate tests with UnitTestBot:
6+
7+
you have to install IntelliJ IDEA (versions from 2022.1 to 2022.1.4 are supported).
8+
9+
### To contribute to UnitTestBot:
10+
11+
you have to install
12+
13+
- IntelliJ IDEA (versions from 2022.1 to 2022.1.4 are supported);
14+
15+
- JDK 11;
16+
17+
- Kotlin 1.7.0 or later;
18+
19+
you also have to check if
20+
21+
- ```JAVA_HOME``` environment variable contains the path to JDK 11 installation directory;
22+
23+
- ```PATH``` environment variable contains the path to the ```bin``` folder of JDK 11 installation directory;
24+
25+
- ```KOTLIN_HOME``` environment variable contains the path to the ```kotlinc``` folder of Kotlin (1.7.0 or later) installation
26+
directory.
27+
28+
Please note: if the environment variables lead to unsupported JDK or Kotlin versions, you won't be able to build the UnitTestBot project.

0 commit comments

Comments
 (0)