Skip to content

Commit 5ba805b

Browse files
committed
fix markdown
1 parent cb7ba9a commit 5ba805b

File tree

5 files changed

+25
-16
lines changed

5 files changed

+25
-16
lines changed

.github/workflows/build-utbot.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@ name: Build UTBot and run unit tests
33
on:
44
pull_request:
55
branches: [main]
6+
push:
7+
branches: [main]
68

79
jobs:
810
matrix-prep:

CONTRIBUTING.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
#How to contribute to UTBot
1+
# How to contribute to UTBot
22

3-
##Want a new feature or change existing one?
3+
## Want a new feature or change existing one?
44
* Create an issue with proposal and describe your idea
55
* Wait for our feedback, it will be decided who is preparing the pull request: we may need your help or fix on our side
66

7-
##Found a defect?
7+
## Found a defect?
88
Ensure this defect wasn't already reported in our [Issues](https://github.com/UnitTestBot/UTBotCpp/issues)
99

1010
If not - create a new one containing:
@@ -15,11 +15,11 @@ If not - create a new one containing:
1515

1616
If you already have a PR with solution - link it with the created issue.
1717

18-
##How to setup development environment?
18+
## How to setup development environment?
1919

2020
Please refer [Developer guide](DEVNOTE.md) to setup developer environment, build and run UTBot.
2121

22-
##How to test you PR?
22+
## How to test you PR?
2323

2424
Currently, not all checks are automized. It's required to do manual testing after PR.
2525
Please perform steps from [SmokeTest.md](SmokeTest.md) before submitting PR for reviewing.

DEVNOTE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
#UTBot Developer Guide
1+
# UTBot Developer Guide
22

33
## How to build UTBotCpp from source
44

README.md

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,8 @@
11
# What is UTBotCpp?
2+
3+
[![Build UTBot and run unit tests](https://github.com/UnitTestBot/UTBotCpp/actions/workflows/build-utbot.yml/badge.svg)](https://github.com/UnitTestBot/UTBotCpp/actions/workflows/build-utbot.yml)
4+
[![Publish UTBot as an archive](https://github.com/UnitTestBot/UTBotCpp/actions/workflows/publish-utbot.yml/badge.svg)](https://github.com/UnitTestBot/UTBotCpp/actions/workflows/publish-utbot.yml)
5+
26
UTBotCpp generates test cases by code, trying to cover maximum statements and execution paths.
37
We treat source code as source of truth assuming that behavior is correct and corresponds to initial user demand.
48
Generated tests are placed in so-called regression suite.
@@ -12,12 +16,15 @@ Features demonstration in 5 min (click to see on [YouTube](https://www.youtube.c
1216

1317
[![UTBot C/C++ Demo](https://img.youtube.com/vi/bDJyWEeYhvk/0.jpg)](https://www.youtube.com/watch?v=bDJyWEeYhvk "UTBot C/C++ Demo")
1418

19+
More info on [wiki](https://github.com/UnitTestBot/UTBotCpp/wiki)
20+
1521
## How to install and use UTBot
1622

17-
For now, you can only use UTBot under Ubuntu.
18-
UTBot has been tested under Ubuntu 18.04 and above.
19-
Navigate to the **Releases** GitHub page and download any version of UTBot.
20-
UTBot is distrbuted as an archive that contains
23+
For now, you can only use UTBot under Ubuntu 18.04 and above.
24+
Navigate to the [**Releases**](https://github.com/UnitTestBot/UTBotCpp/releases) GitHub page and download last version of UTBot.
25+
26+
UTBot is distrbuted as an archive that contains:
27+
2128
1. A pack `utbot_distr.tar.gz` that contains UTBot binary and its dependencies;
2229
2. UTBot plugin for Visual Studio code — `utbot_plugin.vsix`;
2330
3. A version `version.txt`;

SmokeTest.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,21 @@
1-
#How to check UTBot manually
1+
# How to check UTBot manually
22

33
It's recommended to perform some smoke checks on UTBot before raising a pull request
44

5-
##Check installation in your own local environment
5+
## Check installation in your own local environment
66

77
Download an archive with build artifacts on a local machine and unpack it into separate folder locally
88

99

10-
-[ ] Check folder contains:
10+
- [ ] Check folder contains:
1111

1212
- ```utbot_distr.tar.gz``` - UTbot binary/dependencies
1313
- ```utbot_plugin.vsix``` - UTBot plugin for VSCode
1414
- ```unpack_and_run_utbot.sh``` - setup script
1515
- ```version.txt``` - version file
1616

1717

18-
-[ ] Perform setup on server side:
18+
- [ ] Perform setup on server side:
1919

2020
Move binary and script into a new separate directory
2121

@@ -39,13 +39,13 @@ PID/port 2121 should be found
3939

4040
If no errors and process is up then
4141

42-
-[ ] Perform client setup:
42+
- [ ] Perform client setup:
4343

4444
- In local VSCode look for *Install from VSIX* command, select early downloaded ```utbot_plugin.vsix``` and install it - "UnitTestBot for C/C++" plugin should be visible in Extensions
4545
- For Win: setup SSH remote connection with server![img.png](img.png)- locally installed UTBot plugin should be available in remote mode (no new installation required)
4646
- Open folder with source code, test connection as proposed, click Next and finish setup configuring project
4747

48-
##Check UTBot: Generate Tests
48+
## Check UTBot: Generate Tests
4949
On a source code project
5050
- [ ] For Current Function:
5151
1. Move to any function in the (as example) ```file.c```

0 commit comments

Comments
 (0)