testing-spring-2024/README.md
Kristofers Solo 2c5a74ff2e docs: update readme
- Removed multiple top-level headings
- Todos now are checkboxes
2024-03-10 16:05:38 +02:00

36 lines
862 B
Markdown

# Overview
## Project
This is a simple C++ project that includes the function for our colleagues to
test. The function (i.e., the main function and the subfunctions used in it) is
located in `main_lib.cpp`.
## Additional libraries and executable
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 colleagues
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
- [ ] Check the compilation process on Windows and add description in README