From 747de22d384c4aed3a03dfdc705a029f98735563 Mon Sep 17 00:00:00 2001 From: Thomas Hope Date: Thu, 9 Jun 2022 01:56:26 +0100 Subject: [PATCH] Add docs for embed and embedAndSign --- website/docs/embed.md | 23 ++++++++++++++++++----- website/docs/embedandsign.md | 23 ++++++++++++++++++----- 2 files changed, 36 insertions(+), 10 deletions(-) diff --git a/website/docs/embed.md b/website/docs/embed.md index 74cfa063..9b49eb77 100644 --- a/website/docs/embed.md +++ b/website/docs/embed.md @@ -1,16 +1,22 @@ -embed - This page was auto-generated. Feel free to help us improve the documentation by creating a pull request. +--- +title: embed +--- + +Sets value of the *Embed* field in Xcode under *Frameworks, Libraries, and Embedded Content* to **Embed Without Signing** + +This results in the framework being copied into the built app bundle during the *Embed Libraries* build phase. ```lua -embed (value) +embed "Foo.framework" ``` ### Parameters ### -`value` - needs documentation. +`value` is the name of the content to be embedded. ## Applies To ### -The `config` scope. +The `config` scope. Only applies to Xcode projects. ### Availability ### @@ -19,6 +25,13 @@ Premake 5.0.0 beta 1 or later. ### Examples ### ```lua -embed (value) +embed { + "SDL2.dylib", + "bar.framework" +} ``` +### See Also ### + +* [embedAndSign](embedandsign.md) +* [Embedding Frameworks in Xcode](Embedding-Frameworks-in-Xcode.md) \ No newline at end of file diff --git a/website/docs/embedandsign.md b/website/docs/embedandsign.md index bc8f67d5..325aaae8 100644 --- a/website/docs/embedandsign.md +++ b/website/docs/embedandsign.md @@ -1,16 +1,22 @@ -embedandsign - This page was auto-generated. Feel free to help us improve the documentation by creating a pull request. +--- +title: embedAndSign +--- + +Sets value of the *Embed* field in Xcode under *Frameworks, Libraries, and Embedded Content* to **Embed & Sign** + +This results in the framework being copied into the built app bundle during the *Embed Libraries* build phase and signed. ```lua -embedandsign (value) +embedAndSign "SDL2.framework" ``` ### Parameters ### -`value` - needs documentation. +`value` is the name of the content to be embedded and signed. ## Applies To ### -The `config` scope. +The `config` scope. Only applies to Xcode projects. ### Availability ### @@ -19,6 +25,13 @@ Premake 5.0.0 beta 1 or later. ### Examples ### ```lua -embedandsign (value) +embedAndSign { + "SDL2.framework", + "Another.framework" +} ``` +### See Also ### + +* [embed](embed.md) +* [Embedding Frameworks in Xcode](Embedding-Frameworks-in-Xcode.md) \ No newline at end of file