From bf8e2818b76a23293694e7ffde5361eb6f77cc5d Mon Sep 17 00:00:00 2001
From: bialger <artur.bigulov@yandex.ru>
Date: Wed, 17 Jan 2024 09:00:41 +0300
Subject: [PATCH] Added README.md

---
 README.md | 56 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 56 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..f71036d
--- /dev/null
+++ b/README.md
@@ -0,0 +1,56 @@
+# C++ project template with Google Tests and CI/CD
+
+This is a project template. Feel free to use it. It contains all pre-configured 
+CMakeLists.txt, so to use it, just replace project name with your in 
+[main CmakeLists.txt](CMakeLists.txt), and all target and executable names in 
+[CI/CD script](./.github/workflows/ci_tests.yml).
+
+## How to run
+
+Run following commands from project directory.
+
+1. Create CMake cache
+
+```shell
+cmake -S . -B cmake-build
+```
+
+2. Build main target
+
+```shell
+cmake --build cmake-build --target cpp_tests
+```
+
+3. Build tests target
+
+```shell
+cmake --build cmake-build --target cpp_tests_tests
+```
+
+4. Run main target
+
+* On Windows:
+
+```shell
+.\cmake-build\bin\cpp_tests.exe || .\cmake-build\bin\Debug\cpp_tests.exe
+```
+
+* On POSIX:
+
+```shell
+.\cmake-build\bin\cpp_tests
+```
+
+5. Run tests
+
+* On Windows:
+
+```shell
+.\cmake-build\bin\cpp_tests_tests.exe || .\cmake-build\bin\Debug\cpp_tests_tests.exe
+```
+
+* On POSIX:
+
+```shell
+.\cmake-build\bin\cpp_tests_tests
+```