From 2c5a74ff2e9cba3aeb34e48d8b7bb34aa66aa1fe Mon Sep 17 00:00:00 2001 From: Kristofers Solo Date: Sun, 10 Mar 2024 16:05:38 +0200 Subject: [PATCH] docs: update readme - Removed multiple top-level headings - Todos now are checkboxes --- README.md | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index c523ebf..e2205b6 100644 --- a/README.md +++ b/README.md @@ -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