kristoferssolo/testing-spring-2024
1
0
Fork 0
mirror of https://github.com/jorenchik/testing-spring-2024.git synced 2025-10-21 20:10:36 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

docs: update readme

Browse Source 
- Removed multiple top-level headings
- Todos now are checkboxes
This commit is contained in:
Kristofers Solo 2024-03-10 16:05:38 +02:00
parent d6bdcd817f
commit 2c5a74ff2e
1 changed files with 10 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@ -4,19 +4,19 @@
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``.
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
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
## Usage
## Compilation
Compilation on Linux requires cmake and CXX compiler (e.g., g++).
Compilation on Linux requires cmake and CXX compiler (e.g., g++).
```bash
cd src
@ -26,10 +26,10 @@ cmake ../
cmake --build .
```
Resulting binaries are ``build/main`` - the program and ``build/runtests`` to
run tests specified in ``test.cpp``.
Resulting binaries are `build/main` - the program and `build/runtests` to
run tests specified in `test.cpp`.
# TODOS
## TODOS
- Translate README in Latvian
- Check the compilation process on Windows and add description in README
- [ ] Translate README in Latvian
- [ ] Check the compilation process on Windows and add description in README