mirror of
https://github.com/jorenchik/testing-spring-2024.git
synced 2025-10-21 20:10:36 +00:00
b84cde3614
Src directory with simple project with tests and one library. README. CLang format config file.
35 lines
791 B
Markdown
35 lines
791 B
Markdown
# Overview
|
|
|
|
## Project
|
|
|
|
This is a simple C++ project that includes the function for our collegues to
|
|
test. The function (i.e., the main function and the subfunctions used in it) is
|
|
located in ``main_lib.cpp``.
|
|
|
|
## Additional libraries and executables
|
|
|
|
Our library ``Prep`` is concerned with preparation of data prior to the function
|
|
call. ``test.cpp`` is a single test file that will contain the tests of our collegues
|
|
and our own development tests. GTest is used for tests.
|
|
|
|
# Usage
|
|
|
|
## Compilation
|
|
|
|
Compilation on Linux requires cmake and CXX compiler (e.g., g++).
|
|
|
|
```bash
|
|
cd src
|
|
mkdir build
|
|
cd build
|
|
cmake ../
|
|
cmake --build .
|
|
```
|
|
|
|
Resulting binaries are ``build/main`` - the program and ``build/runtests`` to
|
|
run tests specified in ``test.cpp``.
|
|
|
|
# TODOS
|
|
|
|
- Translate README in Latvian
|