Migrate README #8621
Open
Migrate README #8621
+465
−316
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
heckj
requested review from
bnbarham,
MaxDesiatov,
jakepetroules,
xedin,
dschaefer2,
shawnhyam,
bripeticca,
plemarquand,
owenv,
bkhouri,
cmcgee1024 and
daveyc123
as code owners
| @@ -4,8 +4,48 @@ Learn to create and use a Swift package. | |||
|
|
|||
| ## Overview | |||
|
|
|||
| overview content here.... | |||
| A package consists of Swift source files, including the `Package.swift` manifest file. | |||
There was a problem hiding this comment.
"A package consists of Swift source files" -- packages can also be C, C++, or Objective-C, and this is often a misconception about Swift packages that we've heard a lot from developers
"I can't/don't use packages because I don't use Swift".
I'd say something like:
A package consists of a
Package.swiftmanifest file along with source files, resources, and other assets.
|
|
||
| First section content | ||
| - A library defines a module that can be imported by other Swift code. |
There was a problem hiding this comment.
"by other code" or "by other targets" -- it's not only Swift code
| - An executable is a program that can be run by the operating system. | ||
| - A plugin is executable code that the Swift Package Manager may use to provide additional commands or build capabilities. | ||
|
|
||
| The package can also declare `Dependencies`, most frequently other swift packages that provide modules you use. |
|
|
||
| ### About Modules | ||
|
|
||
| Swift organizes code into _modules_. |
There was a problem hiding this comment.
Modules also apply to non-Swift code, might be good to work that in somehow.
| Each module specifies a namespace and enforces access controls on which parts of that code can be used outside of that module. | ||
|
|
||
| A program may have all of its code in a single module, or it may import other modules as _dependencies_. | ||
| Aside from the handful of system-provided modules, such as Darwin on OS X or GLibc on Linux, most dependencies require code to be downloaded and built in order to be used. |
There was a problem hiding this comment.
We must say "macOS" nowadays, not "OS X"
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.
Docs Migration Work
Motivation:
resolves #8595, #8600
Modifications:
Documentation.mdto make it easier to spot.