chore: sync dev with main

FlayaN · Sep 12, 2023 · ca06738 · ca06738
2 parents 0b49ae9 + 18050f4
commit ca06738
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 15 deletions.
diff --git a/Build Release.bat → BuildRelease.bat b/Build Release.bat → BuildRelease.bat
diff --git a/README.md b/README.md
@@ -6,15 +6,17 @@ SKSE core plugin for community-driven advanced graphics modifications.
 
 ## Requirements
 
-- [CMake](https://cmake.org/)
-  - Add this to your `PATH`
-- [PowerShell](https://github.com/PowerShell/PowerShell/releases/latest)
-- [Vcpkg](https://github.com/microsoft/vcpkg)
-  - Add the environment variable `VCPKG_ROOT` with the value as the path to the folder containing vcpkg
+- Any terminal of your choice (e.g., PowerShell)
 - [Visual Studio Community 2022](https://visualstudio.microsoft.com/)
   - Desktop development with C++
-- [CommonLibSSENG](https://github.com/alandtse/commonlibvr/tree/ng)
-  - Add this as as an environment variable `CommonLibSSEPath`
+- [CMake](https://cmake.org/)
+  - Edit the `PATH` environment variable and add the cmake.exe install path as a new value
+  - Instructions for finding and editing the `PATH` environment variable can be found [here](https://www.java.com/en/download/help/path.html)
+- [Git](https://git-scm.com/downloads)
+  - Edit the `PATH` environment variable and add the Git.exe install path as a new value
+- [Vcpkg](https://github.com/microsoft/vcpkg)
+  - Install vcpkg using the directions in vcpkg's [Quick Start Guide](https://github.com/microsoft/vcpkg#quick-start-windows)
+  - After install, add a new environment variable named `VCPKG_ROOT` with the value as the path to the folder containing vcpkg
 
 ## User Requirements
 
@@ -29,17 +31,13 @@ SKSE core plugin for community-driven advanced graphics modifications.
 - Run `cmake`
 - Close the cmd window
 
-## Building
+## Clone and Build
+Open terminal (e.g., PowerShell) and run the following commands:
 
 ```
-git clone https://github.com/doodlum/skyrim-community-shaders.git
+git clone https://github.com/doodlum/skyrim-community-shaders.git --recursive
 cd skyrim-community-shaders
-# pull commonlib /extern to override the path settings
-git submodule update --init --recursive
-#configure cmake
-cmake -S . --preset=ALL
-#build dll
-cmake --build build --config Release
+.\BuildRelease.bat
 ```
 
 ## License