Skip to content

Commit

Permalink
chore: update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ThirdEyeSqueegee committed Sep 8, 2023
1 parent faeabb6 commit d3b558d
Showing 1 changed file with 22 additions and 0 deletions.
22 changes: 22 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,8 @@

### Including CommonLibSF in your project

#### vcpkg

Add the following to your `vcpkg-configuration`:

```json
Expand All @@ -50,6 +52,26 @@ target_link_libraries(${PROJECT_NAME}
CommonLibSF::CommonLibSF)
```

---

#### git submodule

`cd` into your project directory and run:

```ps
git submodule add https://github.com/Starfield-Reverse-Engineering/CommonLibSF extern/CommonLibSF
git submodule update -f --init
```

Then add the following to your `CMakeLists.txt`:

```cmake
add_subdirectory(extern/CommonLibSF)
target_link_libraries(${PROJECT_NAME}
PRIVATE
CommonLibSF::CommonLibSF)
```

## End-User Dependencies

[Starfield Script Extender](https://www.nexusmods.com/starfield/mods/106)
Expand Down

0 comments on commit d3b558d

Please sign in to comment.