Merge pull request #50 from JacobDomagala/26-generate-first-release

[#26]: Generate v0.0.1

.clang-tidy

@@ -1,5 +1,5 @@
 ---
-Checks:          '*,-fuchsia-*,-google-*,-zircon-*,-abseil-*,-modernize-use-trailing-return-type,-llvm*, -hicpp-uppercase-literal-suffix, -readability-uppercase-literal-suffix'
+Checks:          '*,-fuchsia-*,-google-*,-zircon-*,-abseil-*,-modernize-use-trailing-return-type,-llvm*,-hicpp-uppercase-literal-suffix, -readability-uppercase-literal-suffix, -readability-implicit-bool-conversion,-cppcoreguidelines-avoid-magic-numbers, -readability-magic-numbers, -cppcoreguidelines-pro-type-union-access,-cppcoreguidelines-pro-bounds-pointer-arithmetic, -cppcoreguidelines-pro-type-reinterpret-cast-cppcoreguidelines-pro-type-vararg, -cppcoreguidelines-pro-type-vararg, -hicpp-vararg, -altera-id-dependent-backward-branch, -bugprone-easily-swappable-parameters, -readability-identifier-length, -altera-unroll-loops, -cppcoreguidelines-non-private-member-variables-in-classes, -altera-struct-pack-align, -misc-non-private-member-variables-in-classes, -cppcoreguidelines-pro-type-static-cast-downcast, -readability-convert-member-functions-to-static, -cppcoreguidelines-owning-memory'
 WarningsAsErrors: '*'
 HeaderFilterRegex: ''
-FormatStyle:     none
+FormatStyle:     none

.github/workflows/code_quality.yml

@@ -17,3 +17,6 @@ jobs:
       with:
         exclude_dir: dependencies
         apt_pckgs: xorg-dev
+        verbose: true
+        cppcheck_args: |
+            --enable=all --suppress=functionStatic --suppress=unusedFunction --inline-suppr --inconclusive

.gitignore

@@ -308,11 +308,11 @@ paket-files/
 # Project specific folders
 build
 .vscode
-dependencies/Freetype/Freetype*
-dependencies/GLM/glm*
-dependencies/STB_IMAGE/STB_IMAGE*
-dependencies/JSON/JSON*
-dependencies/FMT/FMT*
-dependencies/Imgui/IMGUI*
-dependencies/glfw/GLFW*
+dependencies/freetype/freetype*
+dependencies/glm/glm*
+dependencies/stb_image/stb_image*
+dependencies/json/json*
+dependencies/fmt/fmt*
+dependencies/imgui/imgui*
+dependencies/glfw/glfw*
 *imgui.ini

README.md

@@ -2,22 +2,22 @@
 ![Windows](https://github.com/JacobDomagala/DGame/workflows/Windows%20Full%20Build/badge.svg)
 ![Ubuntu](https://github.com/JacobDomagala/DGame/workflows/Ubuntu%20Full%20Build/badge.svg)
 
-# DGame
+# Looper
+2D Top-down shooter game (and level editor) written in modern C++.
 
-# Build
-**To build this project CMake version 3.5 is required!**
+## Build
+
+Looper is CMake based project working both on Linux (Ubuntu) and Windows. To build it, you will need at least C++17 compiler and CMake version 3.18. </br>
 
-**Windows:**
-- create build folder
-- inside build folder run cmake command, i.e.
-> cmake -G "Visual Studio 15 2017 Win64" ..
-- this command will generate Visual Studio solution file for x64 arch
+Typical build process would look like this:
+```bash
+# Create build directory
+mkdir build && cd build
 
+# Generate build system for Windows/Linux
+cmake -G "Visual Studio 16 2019" ..
+cmake -G "Ninja" ..
 
-# TODO
-- Linux compatibility
-- Improve enemy AI
-- New assets
-- Multiplayer
-- Sound
-- Menu
+# Build
+cmake --build .
+```