aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md20
1 files changed, 20 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..5bffdf2
--- /dev/null
+++ b/README.md
@@ -0,0 +1,20 @@
+# NVIDIA Shadowplay Highlights plugin #
+
+* GFE SDK Version: 1.1.173.5d889305
+* GeForce Experience minimum version: 3.8
+* Plugin version: 0.2
+
+## About
+
+The plugin implements the GFE Shadowplay Highlights functionality for blueprints and provides UE4-style interfaces for C++ code compatibility.
+
+![Shadowplay Highlights](./ThirdParty/NVIDIAGfeSDK/redist/assets/img/menu.jpg)
+
+## How to use
+
+1. Navigate to Engine\Plugins\Runtime\Nvidia
+
+2. Execute: git submodule add -b ShadowplayHighlights_4.18_pluginonly https://github.com/NvPhysX/UnrealEngine.git GfeSDK
+
+
+See the documentation [here](./Documentation/Manual.html) \ No newline at end of file