Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Readme #89

Open
wants to merge 9 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 7 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,9 @@ All updates should be done on dedicated branch, so please don't use master for c

We prefer TDD (https://en.wikipedia.org/wiki/Test-driven_development), so You should cover code as much as possible by UTs.

To write tests we are using gtest library (https://github.com/google/googletest)
To write tests we are using googletest (or simplier gtest) library (https://github.com/google/googletest)

For mocking classes we are using FakeIt (https://github.com/eranpeer/FakeIt)
For mocking classes we were using FakeIt (https://github.com/eranpeer/FakeIt), but we are migrating to googlemock (or simplier gmock) library (https://github.com/google/googletest)

## 4 Recompiling

Expand Down Expand Up @@ -72,4 +72,8 @@ There should be at least one "Ship it" to close review. If someone start new thr

## 6 Merging branch to master

... #ToDo (this will be added just after my branch will be merged)
On Github go to "Pull requests" tab and select Your pull request. Scroll to the bottom of the site. There You should press "Squash and merge" button to merge master with Your branch.

Sometimes this button won't be active. In such case You should probably update Your branch (do this manually or by pressing "Update branch" button). After branch update wait until required jobs will pass. If everything will be ok then "Squash and merge" button should be active.

Your changes should be now on master. You can remove Your branch and start working on new task :)
31 changes: 30 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,5 +74,34 @@ simple-moving-rectangle (You should see some moving white rectangles)

# 4 Running UTs

...
Running UTs is very simple. If You look at available targets:
```sh
cmake --build <build_directory> --target help"
```
You will find all UT binaries (thay have postfix "-ut"). Just build binary You want:
```sh
cmake --build <build_directory> --target <ut_target>
```
and run it:
```sh
<build_directory>\bin\<ut_target>
```

You can also run UTs with cmake. In such case build UT for all targets
```sh
cmake --build <build_directory>
```
and inside <build_directory> run
```
ctest
```
If You want to run only specified tests You can use -R:
```sh
ctest -R <regex>
```
Ctest will run tests that matches <regex>.

For more ctest options run
```
ctest --help
```