From d6bdcd817ffe282f6a0fb12da55fa0ae6598b044 Mon Sep 17 00:00:00 2001 From: Jorens Shtekels Date: Sun, 10 Mar 2024 13:39:47 +0200 Subject: [PATCH] update readme --- README.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 1dba532..c523ebf 100644 --- a/README.md +++ b/README.md @@ -2,14 +2,14 @@ ## Project -This is a simple C++ project that includes the function for our collegues to +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 executables +## 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 collegues +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 @@ -32,3 +32,4 @@ run tests specified in ``test.cpp``. # TODOS - Translate README in Latvian +- Check the compilation process on Windows and add description in README