Skip to content

Commit 301e3da

Browse files
authored
Updates User Guide section of swift-java README.md. (#935)
1 parent d814b5b commit 301e3da

1 file changed

Lines changed: 7 additions & 11 deletions

File tree

‎README.md‎

Lines changed: 7 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -220,24 +220,20 @@ Please read the documentation of both performance testing tools, and note that r
220220

221221
## User Guide
222222

223-
More details about the project can be found in [docc](https://www.swift.org/documentation/docc/) documentation.
223+
The swift-java project's [documentation](https://swiftpackageindex.com/swiftlang/swift-java/main/documentation/swiftjavadocumentation) is available on the Swift Package Index.
224224

225-
To view the rendered docc documentation you can use the docc preview command:
225+
To preview the [DocC](https://www.swift.org/documentation/docc/) documentation, run:
226226

227227
```bash
228+
# macOS
228229
xcrun docc preview Sources/SwiftJavaDocumentation/Documentation.docc
229230

230-
# OR SwiftJava to view SwiftJava documentation:
231-
# xcrun docc preview Sources/SwiftJava/Documentation.docc
232-
233-
# ========================================
234-
# Starting Local Preview Server
235-
# Address: http://localhost:8080/documentation/documentation
236-
# ========================================
237-
# Monitoring /Users/ktoso/code/swift-java/Sources/SwiftJavaDocumentation/Documentation.docc for changes...
238-
231+
# Linux (or any setup where docc is on your PATH)
232+
docc preview Sources/SwiftJavaDocumentation/Documentation.docc
239233
```
240234

235+
To preview the `SwiftJava` documentation instead, use `Sources/SwiftJava/Documentation.docc` as the path.
236+
241237
## Project Status
242238

243239
**This project is under active development. We welcome feedback about any issues you encounter.**

0 commit comments

Comments
 (0)