Skip to content

Commit 3edde2f

Browse files
committed
Formatting
1 parent 446b259 commit 3edde2f

File tree

1 file changed

+8
-6
lines changed

1 file changed

+8
-6
lines changed

COMPILING.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,13 @@
11
# Compiling DieKnow
22

3+
This guide contains instructions on how to build DieKnow's C++ backend from scratch using CMake. The actions in Step 2 will depend on your choice of compiler. Steps 1 and 3 should be identical regardless of which compiler is chosen.
4+
5+
The minimum C++ standard version is C++ 17. However it is recommended to use C++ 20 for compiler optimizations for branch prediction hints.
6+
37
> **Ensure you are on a Windows machine before attempting to compile!**
48
59
## 1) Installing CMake
610

7-
### CMake
8-
911
1. Navigate to the [CMake downloads page](https://cmake.org/download/) and download the latest **Windows x64 Installer**.
1012
2. Run the installer according to the instructions on-screen. Make sure you click the checkbox "Add CMake to the PATH environment variable".
1113

@@ -16,15 +18,15 @@ The compilers MSVC, Clang, and GCC are all supported.
1618
### MSVC
1719

1820
> [!NOTE]
19-
> 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.
21+
> 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.
2022
2123
1. Download the [Visual Studio Build Tools](https://aka.ms/vs/stable/vs_BuildTools.exe).
22-
2. Ensure that "Desktop development with C++" is checked and press "Install"
24+
2. Ensure that "Desktop development with C++" is checked and press "Install".
2325
![](docs/msvc.png)
2426

2527
### GCC/Clang
2628

27-
GCC and Clang can be used on Windows with MSYS2
29+
GCC and Clang can be used on Windows with MSYS2.
2830

2931
1. Download the [MSYS2 installer](https://github.com/msys2/msys2-installer/releases/download/2024-07-27/msys2-x86_64-20240727.exe).
3032
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.
@@ -48,7 +50,7 @@ GCC and Clang can be used on Windows with MSYS2
4850

4951
6. Press the Windows key and type "Edit environment variables for your account".
5052
7. On the top half of the screen, go to "Path".
51-
8. Press Alt-E and then Alt-N
53+
8. Press Alt-E and then Alt-N.
5254
9. Paste the installation directory of MSYS2 you copied when installing MSYS2 and then type `mingw64\bin` to complete the path.
5355
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.
5456

0 commit comments

Comments
 (0)