mirror of
https://github.com/jorenchik/testing-spring-2024.git
synced 2025-10-21 20:10:36 +00:00
52 lines
1.1 KiB
Markdown
52 lines
1.1 KiB
Markdown
# Overview
|
|
|
|
[](https://github.com/jorenchik/testing-spring-2024/actions/workflows/test.yml)
|
|
|
|
[Latvian Description](./README-lv.md)
|
|
|
|
## 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 `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++).
|
|
|
|
### ninja
|
|
|
|
```bash
|
|
cmake -G Ninja -B build
|
|
cd build
|
|
ninja
|
|
./main
|
|
```
|
|
|
|
### Make
|
|
|
|
```bash
|
|
cmake -B build
|
|
cd build
|
|
make
|
|
./main
|
|
```
|
|
|
|
Resulting binaries are `build/main` - the program and `build/runtests` to
|
|
run tests specified in `test.cpp`.
|
|
|
|
## TODOS
|
|
|
|
- [x] Translate README in Latvian
|
|
- [ ] Windows support
|
|
- [x] Check the compilation process on Windows
|
|
- [ ] Add compilation guide
|