CAP: basic functionning template for cc project

Author: 9and3

.gitignore

@@ -37,6 +37,21 @@
 # add the build output folder
 build/
 
+#######################################
+## CMake
+#######################################
+# general file for cmake
+CMakeLists.txt.user
+CMakeCache.txt
+CMakeFiles
+CMakeScripts
+Testing
+Makefile
+cmake_install.cmake
+install_manifest.txt
+compile_commands.json
+CTestTestfile.cmake
+_deps
 
 #######################################
 ## VSCode

.vscode/settings.json

@@ -0,0 +1,5 @@
+{
+    "files.associations": {
+        "iostream": "cpp"
+    }
+}

CMakeLists.txt

@@ -1,7 +1,26 @@
 cmake_minimum_required(VERSION 3.16.)
-
 project(DiffCheck VERSION 1.0.0 LANGUAGES CXX C)
-
 set(CMAKE_CXX_STANDARD 17)
 
+include(CTest)
+enable_testing()
+
+set(BUILD_SHARED_LIBS ON)
+
+list(APPEND CMAKE_MODULE_PATH ${PROJECT_SOURCE_DIR}/cmake)
+
+file(GLOB_RECURSE SOURCES src/*.cc src/*.hh)
+
+add_executable(${PROJECT_NAME} ${SOURCES})
+
+set(EXECUTABLE_OUTPUT_PATH ${CMAKE_BINARY_DIR}/bin)
+
+target_include_directories(${PROJECT_NAME}
+    PUBLIC ${CMAKE_CURRENT_SOURCE_DIR}/src
+    )
+
 
+#--------------------------------------------------------------------------
+# Pre-compiled headers
+#--------------------------------------------------------------------------
+target_precompile_headers(${PROJECT_NAME} PRIVATE src/diffcheckpch.hh)

CONTRIBUTING.md

@@ -29,7 +29,7 @@ git commit -m "WIP-CAP:<description>      <--- for cap moment in not finished wo
 
 ### Naming & synthax convention
 Here's the naming convention for this project:
-- `localVariable`: lowerCamelCase.
+- ` `: lowerCamelCase.
 - `type PrivateVariable`: public member of a class
 - `type m_PrivateVariable`: Hungarian notation with UpperCamelCase for private class members.
 - `static type s_StaticVariable`: Hungarian notation with UpperCamelCase for static members of class.

src/diffCheck.hh

@@ -0,0 +1,3 @@
+#pragma once
+
+#include "diffCheck/template.hh"  // This is a dummy include to test the include path

src/diffCheck/template.cc

@@ -0,0 +1,9 @@
+#include "template.hh"
+
+#include <iostream>
+
+namespace diffCheck {
+  void testTemplateCheck() {
+    std::cout << "Hello, DiffCheck!" << std::endl;
+  }
+}

src/diffCheck/template.hh

@@ -0,0 +1,12 @@
+#pragma once
+
+namespace diffCheck {
+    class TemplateCheck {
+    public:
+        TemplateCheck() = default;
+        ~TemplateCheck() = default;
+    };
+
+    /// @brief Testing function for header import
+    void testTemplateCheck();
+}  // namespace diffCheck

src/diffCheckApp.cc

@@ -1,6 +1,7 @@
-#include <iostream>
+#include "diffcheckpch.hh"
+#include "diffCheck.hh"
 
 int main() {
-  std::cout << "Hello, World!" << std::endl;
+  diffCheck::testTemplateCheck();
   return 0;
 }

src/diffcheckpch.cc

@@ -0,0 +1 @@
+# include "diffcheckpch.hh"

src/diffcheckpch.hh

@@ -0,0 +1,22 @@
+#pragma once
+
+#include <iostream>
+#include <memory>
+#include <utility>
+#include <algorithm>
+#include <functional>
+#include <filesystem>
+
+#include <string>
+#include <string_view>
+#include <sstream>
+#include <array>
+#include <vector>
+#include <stdint.h>
+#include <type_traits>
+#include <typeindex>
+#include <typeinfo>
+#include <unordered_map>
+#include <unordered_set>
+
+#include <stdlib.h>