瀏覽代碼

Added notification that Jolt.h needs to be included first always.

Jorrit Rouwe 3 年之前
父節點
當前提交
3345c27ce6
共有 2 個文件被更改,包括 9 次插入1 次删除
  1. 5 0
      Build/README.md
  2. 4 1
      HelloWorld/HelloWorld.cpp

+ 5 - 0
Build/README.md

@@ -11,6 +11,11 @@ Each platform supports multiple build targets
 - ReleaseCoverage - As Release but turns on Coverage reporting (clang only) to find which areas of the code are not executed
 - Distribution - Shippable version of the library, turns off all debugging support
 
+## Includes
+
+The Jolt headers don't include Jolt.h. Always include Jolt.h before including any other Jolt header.
+You can use Jolt.h in your precompiled header to speed up compilation.
+
 ## Defines
 
 There are a number of user configurable defines that turn on/off certain features:

+ 4 - 1
HelloWorld/HelloWorld.cpp

@@ -1,8 +1,11 @@
 // SPDX-FileCopyrightText: 2021 Jorrit Rouwe
 // SPDX-License-Identifier: MIT
 
-// Jolt includes
+// The Jolt headers don't include Jolt.h. Always include Jolt.h before including any other Jolt header.
+// You can use Jolt.h in your precompiled header to speed up compilation.
 #include <Jolt.h>
+
+// Jolt includes
 #include <RegisterTypes.h>
 #include <Core/TempAllocator.h>
 #include <Core/JobSystemThreadPool.h>