Skip to content

Commit

Permalink
DOC: Added note on embedding in FAQ
Browse files Browse the repository at this point in the history
  • Loading branch information
HappySeaFox committed Sep 23, 2024
1 parent f7e788a commit 57d7c02
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions FAQ.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@ Table of Contents
* [Are there any bindings to other programming languages?](#are-there-any-bindings-to-other-programming-languages)
* [How many image formats are you going to implement?](#how-many-image-formats-are-you-going-to-implement)
* [I have problems with include paths with vcpkg without CMake](#i-have-problems-with-include-paths-with-vcpkg-without-cmake)
* [How to embed SAIL as a subproject?](#how-to-embed-sail-as-a-subproject)
* [I have questions, issues, or proposals](#i-have-questions-issues-or-proposals)

# SAIL Frequently Asked Questions (FAQ)
Expand Down Expand Up @@ -472,6 +473,11 @@ the most popular image formats will be definitely ported from ksquirrel-libs.
Add `VcpkgInstalledDir/include/sail` to the project include path.
See https://learn.microsoft.com/en-us/vcpkg/users/buildsystems/msbuild-integration.
## How to embed SAIL as a subproject?
Embedding SAIL is not fully supported. SAIL alters global CMake variables like `CMAKE_C_FLAGS`,
so embedding it is not recommended. One of the possible options is to build SAIL separately.
## I have questions, issues, or proposals
Opening a GitHub [issue](https://github.com/HappySeaFox/sail/issues) is the preferred way
Expand Down

0 comments on commit 57d7c02

Please sign in to comment.