Initial commit

.editorconfig

@@ -0,0 +1,38 @@
+# EditorConfig is awesome: https://EditorConfig.org
+
+# top-most EditorConfig file
+root = true
+
+# Unix-style newlines with a newline ending every file
+[*]
+end_of_line = crlf
+insert_final_newline = true
+
+# Matches multiple files with brace expansion notation
+# Set default charset
+[*.{js,py}]
+charset = utf-8
+
+# 4 space indentation
+[*.py]
+indent_style = space
+indent_size = 4
+
+# Tab indentation (no size specified)
+[Makefile]
+indent_style = tab
+[*.{cpp,h}]
+indent_style = tab
+indent_size = 4
+trim_trailing_whitespace = true
+
+# Indentation override for all JS under lib directory
+[lib/**.js]
+indent_style = space
+indent_size = 2
+
+# Matches the exact files either package.json or .travis.yml
+[{package.json,.travis.yml}]
+indent_style = space
+indent_size = 2
+

.gitattributes

@@ -0,0 +1,11 @@
+# Set default behavior to automatically normalize line endings.
+* text=auto
+
+# Force batch scripts to always use CRLF line endings so that if a repo is accessed
+# in Windows via a file share from Linux, the scripts will work.
+*.{cmd,[cC][mM][dD]} text eol=crlf
+*.{bat,[bB][aA][tT]} text eol=crlf
+
+# Force bash scripts to always use LF line endings so that if a repo is accessed
+# in Unix via a file share from Windows, the scripts will work.
+*.sh text eol=lf

.github/workflows/generate_docs.yml

@@ -0,0 +1,69 @@
+# This is a workflow that generates documentation
+name: Generating documentation with Doxygen
+
+# Controls when the workflow will run
+on:
+  # Triggers the workflow on push events for the main branch
+  push:
+    branches:
+    - main
+  # Triggers the workflow for pull requests
+  pull_request:
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# A workflow run is made up of one or more jobs that can run sequentially or in parallel
+jobs:
+  # This workflow contains a single job called "document"
+  document:
+    # The type of runner that the job will run on
+    runs-on: ubuntu-latest
+
+    # Steps represent a sequence of tasks that will be executed as part of the job
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v3
+      with:
+        submodules: 'true'
+
+    - name: Print current path
+      run: pwd
+
+    - name: Print directory contents
+      run: ls
+
+    - name: Setup awesome doxygen
+      run: |
+        cd doxygen-awesome-css
+        git checkout v2.2.1
+        cd ..
+      
+    - name: Install doxygen
+      run: |
+        sudo apt-get install wget
+        wget https://github.com/doxygen/doxygen/releases/download/Release_1_9_7/doxygen-1.9.7.linux.bin.tar.gz
+        tar -xvf doxygen-1.9.7.linux.bin.tar.gz
+        cd doxygen-1.9.7
+        sudo make install
+        cd ..
+        rm -rf doxygen-1.9.7
+        rm doxygen-1.9.7.linux.bin.tar.gz
+
+    - name: Install graphviz
+      run: sudo apt-get install graphviz
+
+    - name: Remove existing files
+      run: rm -rf docs
+
+    - name: Generate documentation
+      run: doxygen Doxyfile
+
+    - name: Commit changes
+      # if: (git diff HEAD --name-only | wc -l) > 0
+      run: |
+          git config user.name github-actions
+          git config user.email [email protected]
+          git add ./docs -f
+          git commit -m "Updated the documentation" -v
+          git push
+      continue-on-error: true

.gitignore

@@ -0,0 +1,2 @@
+# The build output directory
+build

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "doxygen-awesome-css"]
+	path = doxygen-awesome-css
+	url = https://github.com/jothepro/doxygen-awesome-css.git

.vscode/settings.json

@@ -0,0 +1,3 @@
+{
+	"cmake.configureOnOpen": true
+}

CMakeLists.txt

@@ -0,0 +1,15 @@
+cmake_minimum_required(VERSION 3.16)
+project(CPP_project)
+
+set(CMAKE_CXX_STANDARD 20)
+
+# Some compiler flags for GCC and Clang, disable if unwanted
+if("${CMAKE_CXX_COMPILER_ID}" MATCHES "Clang" OR "${CMAKE_CXX_COMPILER_ID}" MATCHES "GNU") 
+	set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Wall -Wextra -Wpedantic -Wconversion -Wold-style-cast -Wnull-dereference")
+	set(CMAKE_CXX_FLAGS_DEBUG "${CMAKE_CXX_FLAGS_DEBUG} -O0 -g -DDEBUG")
+	# set(CMAKE_CXX_FLAGS_DEBUG "${CMAKE_CXX_FLAGS_DEBUG} -Werror") # Uncomment to treat warnings as errors
+	set(CMAKE_CXX_FLAGS_RELEASE "${CMAKE_CXX_FLAGS_RELEASE} -O3 -s -DNDEBUG")
+endif()
+
+set(SOURCES src/main.cpp)
+add_executable(executable ${SOURCES})