Skip to content

Commit 0e73cd0

Browse files
Alexey Pleshakovqrort
authored andcommitted
Change "Publish UTBot" workflow trigger, edit README.md
1 parent 4b51023 commit 0e73cd0

File tree

2 files changed

+30
-3
lines changed

2 files changed

+30
-3
lines changed

.github/workflows/publish-utbot.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ name: Publish UTBot as an archive
22

33
on:
44
push:
5-
# branches: [main]
5+
branches: [main]
66

77
jobs:
88
publish:

README.md

Lines changed: 29 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,29 @@
1-
# UTBotCpp
2-
Tool that generates unit test by C/C++ source code, trying to reach all branches and maximize code coverage
1+
# What is UTBotCpp?
2+
UTBotCpp generates test cases by code, trying to cover maximum statements and execution paths.
3+
We treat source code as source of truth assuming that behavior is correct and corresponds to initial user demand.
4+
Generated tests are placed in so-called regression suite.
5+
Thus, we fixate current behavior by generated test cases.
6+
Using UTBotCpp developers obtain full control of their code.
7+
No future change can break the code without being noticed once it's covered with tests generated by UTBot.
8+
This way, modifications made by developers to an existing code are much safer.
9+
Hence, with the help of generated unit tests, UTBot provides dramatic code quality improvement.
10+
11+
## How to install and use UTBot
12+
13+
For now, you can only use UTBot under Ubuntu.
14+
UTBot has been tested under Ubuntu 14, 16, and 18.
15+
Navigate to the **Releases** GitHub page and download any version of UTBot.
16+
UTBot is distrbuted as an archive that contains
17+
1. A pack `utbot_distr.tar.gz` that contains UTBot binary and its dependencies;
18+
2. UTBot plugin for Visual Studio code — `utbot_plugin.vsix`;
19+
3. A version `version.txt`;
20+
4. A run script `unpack_and_run_utbot.sh`.
21+
22+
To launch UTBot, `unzip` the archive and run the
23+
`chmod +x unpack_and_run_utbot.sh && ./unpack_and_run_utbot.sh` command (we recommend doing it in a fresh directory to make UTBot removing easier). To remove UTBot, simply delete this directory.
24+
25+
To install UTBot VSCode plugin, use VSCode *Install from VSIX* command.
26+
27+
## How to contribute to UTBot
28+
29+
See **DEVNOTE.md**.

0 commit comments

Comments
 (0)