Skip to content

Commit d62c480

Browse files
committed
Note that module packages must be git repositories
1 parent 3a4123e commit d62c480

File tree

1 file changed

+14
-1
lines changed

1 file changed

+14
-1
lines changed

Documentation/SystemModules.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,13 @@ contains more “Swifty” function wrappers around the raw C interface.
4949
> When you are done you should push to GitHub or another hosting site so
5050
> the wider community can benefit from your work.
5151
52+
Packages must be semantically-versioned git repositories, so in the `CVorbis` directory:
53+
54+
git init
55+
git add .
56+
git commit -m "Initial Commit"
57+
git tag 1.0.0
58+
5259
We must do the same for `libogg`:
5360

5461
module COgg [system] {
@@ -57,10 +64,16 @@ We must do the same for `libogg`:
5764
export *
5865
}
5966

67+
And then again in the `COgg` directory:
68+
69+
git init
70+
git add .
71+
git commit -m "Initial Commit"
72+
git tag 1.0.0
6073

6174
Note we do not call the module `CLibogg`. In general, avoid the lib prefix unless the authors of the package
6275
typically always refer to it that way. A good rule of thumb is to look at the header files, here we can
63-
see the header is called simply "ogg.h". Pay attention to capitalization; note that we provide `CPOSIX` and not
76+
see the header is called simply "ogg.h". Pay attention to capitalization; it would be `CPOSIX` and not
6477
`CPosix`, because POSIX is an acronym and is typically spelled all-caps.
6578

6679
Back in our example app we need a `Package.swift` that depends on CVorbis:

0 commit comments

Comments
 (0)