Examples: Add READMEs #92
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
euanh
changed the title
euanh
force-pushed
the
docs/example-readme
branch
5 times, most recently
from
e3c82e4 to
e3b001e
Compare
euanh
force-pushed
the
docs/example-readme
branch
from
e3b001e to
aa32538
Compare
heckj
reviewed
Apr 16, 2025
|
|
||
| This example shows you how to use a resource bundle in your service. It builds a Hummingbird server which returns a randomly-selected image from its resource bundle. | ||
|
|
||
| 1. [Install a Static Linux SDK](Sources/ContainerImageBuilderPluginDocumentation/Documentation.docc/ContainerImageBuilderPlugin.md#install-a-swift-sdk-for-cross-compilation-on-macos) for your Swift compiler. For instance, this command installs the Static Linux SDK for Swift 6.1: |
There was a problem hiding this comment.
Since I expect the readme will be viewed within the context of looking at this site on GitHub (or perhaps locally), this might be better as a full https:// link to the host documentation content (guessing SwiftPackageIndex would make the most sense, but possibly GitHub pages if your project is leaning in that direction for some reason)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation
[Explain here the context, and why you're making that change. What is the problem you're trying to solve.]
Modifications
[Describe the modifications you've made.]
Result
[After your change, what will change.]
Test Plan
[Describe the steps you took, or will take, to qualify the change - such as adjusting tests and manual testing.]