Skip to content

Commit

Permalink
docs: improve compilation instructions (#85)
Browse files Browse the repository at this point in the history
* Update README.md

Rework of Readme's instructions to help clarify installation and configuration of requirements to compile Community Shaders.

* Update README.md

* Update README.md

* Update README.md

* Update README.md

Removed explicit install instructions for Vcpkg in the event changes are made upstream to its installation process.

* Update README.md
  • Loading branch information
AceAmir committed Sep 10, 2023
1 parent 5d4f45b commit 5622ccf
Showing 1 changed file with 10 additions and 7 deletions.
17 changes: 10 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -30,6 +32,7 @@ SKSE core plugin for community-driven advanced graphics modifications.
- Close the cmd window

## Building
Open terminal (e.g., PowerShell) and run the following commands:

```
git clone https://github.com/doodlum/skyrim-community-shaders.git
Expand Down

0 comments on commit 5622ccf

Please sign in to comment.