Skip to content

Commit e236af7

Browse files
committed
Improve README build and import instructions
Add a section on building the documentation in Xcode. Also, cleaned up the import documentation into Xcode section.
1 parent d1f963a commit e236af7

File tree

1 file changed

+13
-3
lines changed

1 file changed

+13
-3
lines changed

README.md

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,14 +12,24 @@ This will bring up a local web server, so you can view the documentation locally
1212
make preview
1313
```
1414

15-
### Docc Archive (Xcode)
15+
### DocC Archive (Xcode)
1616

1717
Generate a DocC Archive that will be automatically imported into Xcode's documentation.
1818

1919
```
2020
make docc
2121
```
2222

23+
#### Build DocC Archive in Xcode
24+
25+
Generate a DocC Archive in Xcode. This documentation will be available under the Workspace Documentation section.
26+
You will need to export `WebKit` and import it to add the DocC Archive to the Imported Documentation section.
27+
28+
```
29+
Open Package.swift
30+
Product -> Build Documentation (⌃⇧⌘D)
31+
```
32+
2333
### GitHub Release
2434

2535
Generate documentation for a release on GitHub Pages.
@@ -30,5 +40,5 @@ make github
3040

3141
## Import Documentation into Xcode
3242

33-
Open `WebKit.doccarchive` and it will be automatically be imported into Xcode.
34-
Running `make docc` will also launch Xcode and import the document.
43+
Open `WebKit.doccarchive` and the documentation will be automatically imported into Xcode under the Imported Documention section.
44+
When running `make docc` the documentation will automatically be imported into Xcode.

0 commit comments

Comments
 (0)