Add compiling instructions for CMake

Author: eschan145

COMPILING.md

@@ -2,58 +2,66 @@
 
 > **Ensure you are on a Windows machine before attempting to compile!**
 
-## 1) Installing gcc
+## 1) Installing CMake
 
-You'll need a C++ compiler that supports C++20 in order to compile DieKnow's C++ functions. DieKnow has been developed on Microsoft Visual Studio using the `gcc` compiler, but it can be developed on Visual Studio Code or any text editor with the following compilers:
+### CMake
 
-* Microsoft Visual Studio C++ (MSVC)
-* GNU Compiler Collection (gcc)
-* Clang
+1. Navigate to the [CMake downloads page](https://cmake.org/download/) and download the latest **Windows x64 Installer**.
+2. Run the installer according to the instructions on-screen. Make sure you click the checkbox "Add CMake to the PATH environment variable".
 
-1. Download the [MSYS2 installer](https://github.com/msys2/msys2-installer/releases/download/2024-07-27/msys2-x86_64-20240727.exe)
+## 2) Installing a Compiler
+
+The compilers MSVC, Clang, and GCC are all supported.
+
+### MSVC
+
+> [!NOTE]
+> Although it is the recommended and best-supported way to build DieKnow, installing MSVC requires administrator privileges. Choose GCC or Clang instead if you do not have them.
+
+1. Download the [Visual Studio Build Tools](https://aka.ms/vs/stable/vs_BuildTools.exe).
+2. Ensure that "Desktop development with C++" is checked and press "Install"
+   ![](docs/msvc.png)
+
+### GCC/Clang
+
+GCC and Clang can be used on Windows with MSYS2
+
+1. Download the [MSYS2 installer](https://github.com/msys2/msys2-installer/releases/download/2024-07-27/msys2-x86_64-20240727.exe).
 2. Open the MSYS2 installer and follow the instructions to install MSYS2. Copy the path that you inputted when asked. You'll need it later.
 3. Once it has finished installing, open up the newly installed app "MSYS2 UCRT64", found by typing the name after pressing the Windows key.
 4. Type the following command to synchronize the MSYS2 package database. The terminal will close, and you'll have to reopen it again.
 
    ```bash
    pacman -Syu
    ```
-5. Once the terminal reopens, type the following command to install `g++`
+5. Once the terminal reopens, type the following command to install Clang or GCC, depending on your choice.
 
    ```bash
-   pacman -S mingw-w64-x86_64-gcc
+   pacman -S mingw-w64-x86_64-clang
    ```
-6. Congratulations! You should have gcc installed on your machine. However, you'll need to add it to your system's PATH environment variable for it to be accessible.
 
-### Adding to PATH
+   OR
 
-1. Press the Windows key and type "Edit environment variables for your account".
-2. On the top half of the screen, go to "Path".
-3. Press Alt-E and then Alt-N
-4. Paste the installation directory of MSYS2 you copied when installing MSYS2 and then type `mingw64\bin` to complete the path.
-5. To check if it works, open up a Command Prompt window and type `g++`. If it says "no input files", you have successfully added g++ to your path.
+   ```bash
+   pacman -S mingw-w64-x86_64-gcc
+   ```
 
-## 2) Using the compilation command
+6. Press the Windows key and type "Edit environment variables for your account".
+7. On the top half of the screen, go to "Path".
+8. Press Alt-E and then Alt-N
+9. Paste the installation directory of MSYS2 you copied when installing MSYS2 and then type `mingw64\bin` to complete the path.
+10. To check if it works, open up a Command Prompt window and type `g++` or `clang++`, depending on what compiler you chose. If it says something like "No input files" they have been added to PATH.
 
-1. Use `cd` to cd to the directory where you downloaded DieKnow.
-2. Open up a Command Prompt or Powershell window and type the following command to compile `api.cpp` into a DLL.
+## 3) Compiling
 
+1. Open up a terminal in Command Prompt or PowerShell.
+2. Type the following command to configure CMake:
    ```bash
-   g++ -Ofast -Wall -shared -std=c++20 -static -o src/dlls/api.dll src/api.cpp -lgdi32
+   cmake -S . -B build
    ```
-
-3. If it works, type the following command to compile the GUI:
-
+3. You can build the configured CMake files with the following command:
    ```bash
-   g++ -Ofast -Wall -shared -std=c++20 -static -o src/dlls/gui.dll src/gui.cpp -lgdi32 -lcomctl32
+   cmake --build build --config <Config>
    ```
-
-Note that if you use another compiler such as MSVC or CL, you will need to link additional libraries such as `user32` or `shell32` or even `advapi32`.
-
-Several options are used:
-
-* `-Ofast` compiles into the FASTEST DLL as it possibly can.
-* `-Wall` enables all compile warnings.
-* `-std=c++20` sets the C++ standard to C++20.
-* `-static` links the DLL dependencies statically.
-* `-lgdi32`, `-lcomctl32` link the needed libraries for Graphics Driver Interface and Windows Common Controls, respectively.
+   Where `<Config>` is the preset; one of either `Debug` or `Release`. `Release` enables optimizations but removes binary information useful for debugging and takes longer to compile. Make sure to remove the brackets ()`<>`).
+4. If the command succeeds a `dieknow.dll` should be placed in the `src/dlls` directory.