Browse Source

Further clarified folder structure.

Jorrit Rouwe 3 years ago
parent
commit
670c151b7b
1 changed files with 2 additions and 2 deletions
  1. 2 2
      README.md

+ 2 - 2
README.md

@@ -90,12 +90,12 @@ For build instructions go to the [Build](Build/README.md) section.
 
 ## Folder Structure
 
-* Assets - This folder contains assets used by the Samples.
+* Assets - This folder contains assets used by the TestFramework, Samples and JoltViewer.
 * Build - Contains everything needed to build the library, see the [Build](Build/README.md) section.
 * Docs - Contains documentation for the library.
 * HelloWorld - A simple application demonstrating how to use the Jolt Physics library.
 * Jolt - All source code for the library is in this folder.
-* JoltViewer - It is possible to record the output of the physics engine using the DebugRendererRecorder class (a .jor file), this folder contains the source code to an application that can visualize a recording. This is useful for e.g. visualizing the output of the PerformanceTest on different platforms.
+* JoltViewer - It is possible to record the output of the physics engine using the DebugRendererRecorder class (a .jor file), this folder contains the source code to an application that can visualize a recording. This is useful for e.g. visualizing the output of the PerformanceTest from different platforms. Currently available on Windows only.
 * PerformanceTest - Contains a simple application that runs a performance test and collects timing information.
 * Samples - This contains the sample application, see the [Samples](Docs/Samples.md) section. Currently available on Windows only.
 * TestFramework - A rendering framework to visualize the results of the physics engine. Used by Samples and JoltViewer. Currently available on Windows only.